我曾在一些没有使用源代码管理的地方工作过。他们似乎养成了在更改的代码周围添加注释来解释更改的习惯，以便可以恢复事情。
我发现这使得代码非常难以阅读，并且相当坚定地认为在引入源代码控制之后不需要这样的注释，因为修订历史记录将让您将票证与更改相匹配。
但是现在，我不太确定，我认为最好在文件和提交消息中记录对文件的主要修订。这应该会使代码更具可读性。人们是否有记录代码更改的最佳实践方法，以便它不会太混乱，但仍然对试图阅读它的人有解释？
需要明确的是，我不是在谈论文件头中的更改列表（这是一个完整的其他参数），而是在代码中的注释。
大多数源代码控制系统都有“注释”或“责备”命令。它显示了每次修订后更改的代码。
由于此信息不会改变程序的行为，或者使程序更容易理解，因此它不属于程序。
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
