PHPDoc函数更改日志(@change?)

时间:2010-04-17 16:54:43

标签: php documentation phpdoc

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

这样的东西
@change 2010.20.16  user  added feature x
@change 2010.20.26  user  added feature y

会很棒。但是假设没有@change选项...如果我添加它,那么PHPDoc会用它做什么?或者是否有更好/更正确的方法来记录功能变化?

1 个答案:

答案 0 :(得分:3)

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

原因:

  1. 陈旧 - 如果你停止添加改变音符,如果不得不进行编码马拉松/厄运的冲刺,那么任何人都不会有任何好处。

  2. 非常规 - 我不记得在内联文档中看到了一个具有深度内容的项目。有时惯例很简单,但我认为这个问题的智慧是减少维护。