когда обновлять тег @author в PHPdoc?
Это действительно новый вопрос.
Я пытаюсь улучшить свои навыки с помощью PHP, поэтому я читаю код некоторых библиотек. Я заметил, что многие Заголовки PHPdoc (это правильное имя? Я имею в виду это:
/**
* @param $config
* @return bool
* @author developer1
*/
) содержат тег @author.
Допустим, developer2 вносит огромные изменения в функцию developer1, а затем выполняет коммит в github. Должен ли developer2 обновить тег @author?
Какова общая практика?
Решение
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
Другие решения
Других решений пока нет …