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

wwr*_*wwr 7 php phpdoc

这真的是一个新手问题.

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

 /**
 * @param  $config
 * @return bool
 * @author developer1
 */
Run Code Online (Sandbox Code Playgroud)

)包含@author标记.

假设developer2对developer1的函数进行了大量更改,然后提交给github.developer2应该更新@author标签吗?

常见的做法是什么?

Sty*_*tyx 6

phpDocumentor 2支持多个@author标签:

/**
 * Class User
 * @author Styx
 * @author second author
 * @package Application\Model
 */
class User
{
}
Run Code Online (Sandbox Code Playgroud)

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

  • @wwr phpDocumentor和Doxygen是受欢迎的替代品。 (2认同)