phpDocumentor — Как задокументировать код обновления другого автора и дату?

Допустим, исходная документация для класса выглядит так:

/**
 * My custom class
 *
 * This class helps you do stuff.  It's really great.
 *
 * @author  David Smith
 * @version 1.0
 */
  1. Если я приду и переделаю 50% кода, как мне документально подтвердить, что я внес существенный вклад?

  2. Как лучше добавить дату? например Когда последний раз изменялся код, когда я делал обновления или когда обновлялась версия.


person BadHorsie    schedule 09.11.2012    source источник


Ответы (2)


Я знаю, что на самом деле не отвечаю на ваш вопрос, но мне интересно, почему вы вообще используете @author.

Для отслеживания изменений в коде (кто создал файл? кто изменил его?) используйте вашу систему контроля версий. Ведь для этого он и нужен :)

person Fusselwurm    schedule 09.11.2012
comment
Я согласен, но некоторые неприятные злые плохие места не используют (настоящий) контроль версий... Мне приходилось работать в таких местах... Это просто неправильно. - person Idiot211; 09.11.2012
comment
@Fusselwurm Правильное замечание, но что, если класс будет распространяться вне контроля версий? - person BadHorsie; 16.11.2012
comment
+1. Моя команда использует поле автора для указания человека, хорошо разбирающегося в методе — скорее хранителя, чем обязательно человека, изначально написавшего код. Так что, если вы попали в код и хотите задать вопросы о нем, это хорошее место для начала. Для получения более подробной информации о том, кто что изменил, когда и почему, история чекинов идеальна - зачем загрязнять код этой информацией. - person Jason Williams; 02.03.2013
comment
Я согласен с точкой зрения @BadHorsie, тенденции кода распространяются вне контроля версий, например, если вы работаете на внешнего клиента, если вы делаете открытый исходный код (и кто-то разветвляет его в другом продукте) и тому подобное . Контроль версий предназначен только для команды разработчика/обслуживающего процесса. Однако код может жить вне его. - person magallanes; 05.03.2016

Один из способов, который я видел в компаниях, в которых я работал на протяжении многих лет, заключается в следующем:

 /**
 * My custom class
 *
 * This class helps you do stuff.  It's really great.
 *
 * @author  David Smith
 * @version 1.0
 *
 * @modifier Rahul Parkar
 * @modifiedDate 09/11/2012
 */

Кроме того, я видел, как они используют 2 метода для документирования изменений: один — использовать что-то вроде Git, где каждый коммит имеет сообщение о коммите, другой — использовать другой тег Doc для документирования изменений.

person Idiot211    schedule 09.11.2012