PHPDoc函数更改日志(@change?)
使用PHPDoc记录函数中的更改的最佳方式是什么?差不多PHPDoc函数更改日志(@change?),php,documentation,phpdoc,Php,Documentation,Phpdoc,使用PHPDoc记录函数中的更改的最佳方式是什么?差不多 @change 2010.20.16 user added feature x @change 2010.20.26 user added feature y 那太好了。但是假设没有@change选项。。。如果我添加它,PHPDoc将如何处理它?或者是否有更好/更正确的方法记录函数更改?最好将SCM日志转储到changelog txt文件中,然后尝试将其嵌入源代码中 原因: 过时-如果你停止添加更改注释,这对任何人都没有任何好处
@change 2010.20.16 user added feature x
@change 2010.20.26 user added feature y
那太好了。但是假设没有
@change
选项。。。如果我添加它,PHPDoc将如何处理它?或者是否有更好/更正确的方法记录函数更改?最好将SCM日志转储到changelog txt文件中,然后尝试将其嵌入源代码中
原因:
(参考文献)+1。SCM方法的优点是将提交消息与应用的更改绑定在一起。像OP建议的内联注释实际上不会显示相关的更改。