何时更新 PHPdoc 中的标签 @author？ [关闭]答案

【问题标题】：when to update the tag @author in PHPdoc? [closed]何时更新 PHPdoc 中的标签 @author？ [关闭]
【发布时间】：2014-12-31 11:09:08
【问题描述】：

这真是一个新手问题。

我正在尝试提高我的 PHP 技能，所以我正在阅读一些库的代码。我注意到许多 PHPdoc 标头（这是正确的名称吗？我的意思是：

 /**
 * @param  $config
 * @return bool
 * @author developer1
 */

) 包含@author 标签。

假设 developer2 对 developer1 的函数进行了巨大的更改，然后提交到 github。 developer2 是否应该更新@author 标签？

常见的做法是什么？

【问题讨论】：

如果您希望提高 PHP 技能，您可能应该使用仍在维护的文档系统 - PHPDoc 自 2000 年以来一直没有发布。我不认为这是一个 PHP 问题，真的 - 这是您与许可证、您的团队和原作者一起决定的事情。
manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/…
作者通常只是最初创建/构思文件的人。
@Mark 所以，假设有一天我可以为一个开源项目做出贡献，我将保持 \@author 原封不动，我不会在标题上添加任何关于我的内容，对吧？或者我应该向项目负责人询问项目中通过的约定？
@wwr 询问项目负责人。这主要是基于意见的，并且会因团队而异。

标签： php phpdoc

【解决方案1】：

phpDocumentor 2 支持多个@author 标签：

/**
 * Class User
 * @author Styx
 * @author second author
 * @package Application\Model
 */
class User
{
}

【讨论】：