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.
发布评论
评论（1）
最好将 SCM 日志转储到变更日志 txt 文件中，然后尝试将其嵌入到源代码中。
原因：
过时 - 如果您停止添加更改注释，这对任何人都没有任何好处，如果必须进行编码马拉松/末日冲刺，则可能会发生这种情况。
非常规 - 我不记得见过有如此深入的内联文档的项目。有时约定完全是愚蠢的，但我认为明智的做法是减少维护。
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.