Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this 开发者_开发知识库questionWhat is the best way to document changes in a function with PHPDoc? Something like
@change 2010.20.16 user added feature x
@change 2010.20.26 user added feature y
would be great. But assume there's no @change
option... If i add it anyways, what will PHPDoc do with it? Or is there a better / more correct way to document function changes?
It might be better to just dump your SCM log into a changelog txt file then try to embed it into the source code.
Reasons why:
Staleness - It won't do anyone any good if you stop adding change notes which is likely to happen if having to go on a coding marathon/sprint of doom.
Unconventional - I can't remember seeing a project with that in depth of inline documentation. Sometimes conventions are flat out stupid, but I think the wisdom for this one is cutting down on maintenance.
精彩评论