1

我正在编写一个最终将在 JED 中列出的模块。我有点不确定如何为模块或插件中的每个文件正确构建 docblock 注释。如果我有一个模块也是包的一部分，我是这样写 docblock 注释的：

/**
 * @package     MyPackageName (or Joomla.Platform or Joomla.Site??)
 * @subpackage  mod_my_module
 * @copyright   Copyright 2005 - 2013 Open Source Matters. All rights re-served.
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

我需要包含LICENSE.txt在模块文件夹中吗？如果是，我从哪里得到这个文件？

如果我的模块不属于任何包怎么办？那么我不需要同时包含@packageand@subpackage吗？

4

1 回答 1

1

如Joomla Docs所述，您需要包括以下内容：

  1. 包裹
  2. 版本
  3. 作者
  4. 版权
  5. 执照

像这样：

/**
 * @package PACKAGE_NAME
 * @version VERSION_NUMBER
 * @author YOUR NAME HERE
 * @copyright (C) 2013- YOUR NAME HERE
 * @license GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
**/

如果您愿意，您可以添加您自己的内容，例如包括创建日期、修改日期等。

我发现了很多不使用license.txt文件的扩展，但为了安全起见，包括一个，但它不需要与扩展一起安装。

所有要求都在我上面提供的链接中:)

更新：

我从来没有真正使用过“版本”部分中的所有信息。我只需添加版本号即可。不过，在文档中，所有内容都像这样组合成一个：

$Id: 
 - mod_XYZ.php   >> name of file
 - 599           >> version number
 - 2010-03-20    >> date
 - 23:26:33Z     >> time  (not sure what the **Z** is for though) 
 - you           >> author
$

这不是强制性的，因为您已经指定了要领，因此您可以简单地使用： 

@version 1.2  or   @version 1.3  etc

希望这可以帮助

于 2013-11-11T14:50:28.170 回答