我如何评论我从另一位作者修改的PHP类？

Question

我正在修改另一位作者写过的类。我想知道什么是正确的方式添加我的文档修改，同时确保给原作者适当的信用。我应该重置版本还是继续吗？我应该添加原始PHPDoc注释还是应该创建自己的单独块？

Answer 1

你应该使用版本控制系统，如git，mercurial或subversion，并执行代码所需的任何操作。提交中的日志条目将标识谁更改了内容。

除此之外，如果您只更改内联文档，请在更改日志中添加一行，指明您的操作。你可能会碰到版本号，但那是有争议的。

Answer 2

听起来像是在问你应该如何更新 docblock的信息值，而不是记录你做过修改。如果是这样，那么只需在docblock的说明中添加您的其他信息，并添加任何新的@标签（如果适用）。

如果您仍想要突出作者身份，请使用@author标签显示原件和您自己。