我注意到开发人员以目的/日期/原因在变更日志中为由而较少评论他们的变更的趋势。他们有一些非常合理的说法，如果我们需要两者，就会发生重复工作。我花了很多时间来追踪变化。没有给出具体的方向，缺乏一致的方法让我有点恼火。人们通常会同时做这两种事情吗？有没有我可能想尝试的工具来减少搜索时间。目前我们有 cvs、git 和 svn 实现。
最佳答案
代码中的注释应该描述代码当前的作用。只有当代码的预期行为发生变化时，这些注释才会发生变化——如果修订只是错误修复，则它们不应发生变化。
更改日志中的评论应描述此修订版中所做的更改。
推论:避免在代码注释中放置修订号/日期和进行更改的程序员的姓名。 (感谢两位乔纳森。)
关于svn - 您应该在代码和变更日志中评论更改吗？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/720082/