php - PHPDoc 函数更新日志 (@change?)

Question

使用 PHPDoc 记录函数更改的最佳方法是什么？就像是

@change 2010.20.16  user  added feature x
@change 2010.20.26  user  added feature y

会很好。但是假设没有@change选择......如果我无论如何都添加它，PHPDoc 会用它做什么？还是有更好/更正确的方法来记录功能更改？

Answer 1

最好将 SCM 日志转储到 changelog txt 文件中，然后尝试将其嵌入到源代码中。

原因：

1. 陈旧 - 如果您停止添加更改注释，这对任何人都没有任何好处，如果不得不进行编码马拉松/厄运冲刺，这可能会发生。

2. 非常规 - 我不记得看到过具有内联文档深度的项目。有时约定是完全愚蠢的，但我认为这样做的智慧是减少维护。