我曾经在一些没有使用过源代码控制的地方工作过.他们似乎习惯于对他们改变的代码进行评论,以解释变化,以便可以恢复原状.
我发现这使得代码非常难以阅读,并且在引入源代码控制之后不太需要这样的注释,因为修订历史记录将允许您将票证与更改匹配.
但是现在,我不太确定,我认为在文件和提交消息中记录文件的主要修订可能会很好.这应该使代码更具可读性.人们是否有记录代码更改的最佳实践方法,以便它不会太混乱,但对于试图阅读它的人来说仍然是解释性的？
为了清楚起见,我不是在讨论文件头部的变化列表(这是一个完整的其他参数),而是代码中的注释.
大多数源控制系统都有"Annotate"或"blame"命令.它显示了每个修订版更改的代码.
由于此信息不会更改程序的行为,或者使程序更容易理解,因此它不属于程序.
京公网安备 11010802040832号 | 京ICP备19059560号-6 