何时更新PHPdoc中的标签@author? [关闭]

何时更新PHPdoc中的标签@author?  [关闭]

问题描述:

This is really a newbie question.

I'm trying to improve my skills with PHP, so I'm reading the code of some libraries. I noticed that many PHPdoc headers (is this the right name? I mean this:

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

) contain the @author tag.

Let's say that developer2 makes huge changes to developer1's function and then commits to github. Should developer2 update the @author tag?

What's the common practice?

这真是一个新手问题。 p>

我正在努力提高 我的PHP技能,所以我正在阅读一些库的代码。 我注意到很多 PHPdoc标头 em>(这是正确的名字吗?我的意思是: p>

  / ** 
 * @param $ config 
  * @return bool 
 * @author developer1 
 * / 
  code>  pre> 
 
 

)包含@author标签。 p>

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

通常的做法是什么? p> div>

phpDocumentor 2 support multiple @author tags:

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

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