Question

我正在编写一个最终将在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？如果是，我从哪里获取此文件？

如果我的模块不属于任何包装怎么办？那么我是否不需要同时包含@package和@subpackage？

Answer 1

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

包
版本
作者
版权
许可证

/**
 * @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

希望这有帮助

Joomla DocBlock标题指南

1 个答案: