Как бы я прокомментировал PHP-класс, который я модифицирую от другого автора?

Question

Есть класс, который я изменяю, который написал другой автор.Мне интересно, как правильно добавить мои модификации в документацию, убедившись в том, что первоначальный автор получил должное признание.Должен ли я сбросить управление версиями или продолжить?Должен ли я добавить к оригинальным комментариям PHPDoc или создать свой отдельный блок?

Answer 1

вы должны использовать систему контроля версий, такую ​​как git, mercurial или subversion, и делать все, что нужно с кодом. Записи в ваших коммитах будут определять, кто что изменил.

За исключением того, что если вы изменяете только встроенную документацию, добавьте в журнал изменений строку, указывающую, что вы сделали. Вы можете поднять номер версии, но это спорно.

Answer 2

Мне кажется, что вы спрашиваете, как вам следует обновить информационное значение докблока, а не записывать, что вы внесли изменения.Если это так, то просто добавьте свою дополнительную информацию в описание докблока и добавьте все новые теги @, если они применимы.

Если вы все еще хотите выделить авторство, используйте теги @author, чтобы показать оригинал (ы).) и себя.