何时更新PHPdoc中的标签@author?

时间:2014-11-04 14:08:56

标签: php phpdoc

这真是一个新手问题。

我试图用PHP提高自己的技能,所以我正在阅读一些库的代码。我注意到很多 PHPdoc标题(这是正确的名字吗?我的意思是:

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

)包含@author标记。

让我们说developer2对developer1的函数做了很大的改动,然后提交给github。 developer2应该更新@author标签吗?

通常的做法是什么?

1 个答案:

答案 0 :(得分:4)

phpDocumentor 2支持多个@author标记:

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

http://www.phpdoc.org/docs/latest/references/phpdoc/tags/author.html