我注意到开发人员倾向于评论他们的更改,而不是目的/日期/原因在更改日志中的理由.他们有一些非常合理的说法,如果我们两者都需要,就会发生重复劳动.我花了一些时间来追踪变化.没有给出明确的方向,缺乏一致的方法让我有点恼怒.通常人们都在做两件事吗？是否有我想尝试的工具来减少寻线时间.Currenltly我们有cvs,git和svn实现.
代码中的注释应描述代码当前的功能.只有当代码的预期行为发生变化时,这些注释才会改变- 如果修订只是一个错误修复,它们就不应该改变.
更改日志中的注释应描述此修订中所做的更改.
推论:避免将修订号/日期和在代码注释中进行更改的程序员的名称放在一起.(感谢Jonathans.)
不要使用解释更改的注释来混淆代码.这只是需要维护的一件事,可能不会一致,导致更多错误和更多变化.使用源代码管理注释功能来实现预期目的.
如果您需要解释为什么在代码中的注释中以某种方式完成某些操作,那很好.只要每次更改都不需要.这导致了杂乱的评论
// fixed bug #3365
京公网安备 11010802040832号 | 京ICP备19059560号-6 