如何基于GNU/GPL源代码对PHP文件进行属性注释


How to propertly comment a PHP file based on GNU/GPL source

我的问题很简单。我有一个基于GNU/GPL 2.0许可证交付的另一个应用程序的应用程序(简而言之:我将使用相同的许可证和新名称交付的更改代码)。我的php文件头应该是什么样子,以使一切正常(不要破坏GNU/GPL 2.0许可证)。举个例子就好了。

下面是一个很好的例子:

/**
 * @package     GovArticle.Administrator
 * @subpackage  com_govarticle.layouts
 * @author      Artur Stępień (artur@example.pl)
 * @copyright   (C) 2005 - 2015 Open Source Matters. All rights reserved.
 * @copyright   (C) 2015 - Fundacja PCJ Otwarte Źródła
 * @license     http://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html   
 * @link        http://dostepny.joomla.pl
 * 
 * Based on com_content layouts from Joomla!
 */

(基于pear.php.net示例文件)

@copyrights用于标记谁拥有原始代码的版权。也可以有多个@author标签来显示谁是原始来源的作者(在我的情况下,没有原始作者,只有版权标记)。

GNU/GPL 2.0不需要特定的文档样式,但建议您在每个源文件中包含以下文本:

此文件是Foobar的一部分。

Foobar是免费软件:你可以重新分发和/或修改它根据GNU通用公共许可证的条款自由软件基金会,许可证的第3版,或(由您选择)任何更高版本。

Foobar的分发是希望它有用,但无任何保证;甚至没有适销性或特定用途的适用性。请参阅GNU通用公共许可获取更多详细信息。

您应该已经收到GNU通用公共许可证的副本以及Foobar。如果没有,请参阅http://www.gnu.org/licenses/.

您可能不需要在每个文件中都有长时间的通知,请参阅源文件中的版权声明/免责声明,您所显示的内容可能就足够了。

如果您希望使用标准的方式来记录代码,可以使用phpDocumentor(phpDoc)。

PEAR有一个很好的示例文件,说明如何对代码进行文档化。

编辑:如果你在自己的程序中使用第三方GPL代码,你也应该归属于原作者,请参阅下面Flosculus的评论。