对sourcecontrol中的变更集的好评

Question

当我们在版本控制系统(例如TFS)中注册代码时,我们需要开发用于编写注释的指南.

例如,当我们提交错误修正时,我们会创建一个注释"修复错误#..."

我们试图就这一主题进行头脑风暴,但大多数想法带来的附加值太少.

我将不胜感激任何建议.

Answer 1

通常,我工作的评论是对所做更改的快速概述.简短而简单的东西.

它最初可能似乎没有增加太多价值,但是当回顾历史试图找到什么时候发生变化时更是如此(更多的是"bug #####").有几次我需要回到源代码控制历史记录中来尝试查找特定行为或代码片段何时更改,并且快速概述可以更容易地跟踪可能的位置.如果您只是提供一个错误号,那么您必须做更多工作才能找到基本信息(启动错误跟踪器并找到错误).

Answer 2

围绕这个主题的我(相当精辟)的指导是"记录你为什么要改变而不是什么."

也就是说,你不应该说"在MyClass.cs和FooBar.cs中修复了错误",因为这个评论是相当无关紧要的 - 他们只需查看变更集即可找到这些细节.与TFS同样,将变更集链接到工作项意味着在评论中包含工作项引用是非常多余的.相反,在查看变更集的重要历史时,最简单的解释变更原因的句子,例如"编辑器中固定的潜在XSS漏洞"是最有用的.