为什么签入/提交注释是某些源控制系统中的必填字段？

在Perforce(至少GUI)中,需要签入/提交注释.(我不相信它们在Git或Subversion中是必需的.)大多数与我合作的开发人员只需填写最新/更新/等.我曾经写过有意义的描述,但每天约有20条评论,比如"替换图像".'改变'franhcise'的拼写变得非常烦人.此外,大多数变化都可以在Diff中快速看到.

起初我以为我只是懒惰,但在审查其他人的代码时我甚至不会看它们.我宁愿直奔Diff.我一个人吗？需要评论是个好主意吗？

你应该总是留下好评.不一定描述你改变了什么,除非它是一个包含太多令人分心的小细节的大变更集......但总是,总是描述你为什么要做出改变(如果有的话,可以链接到bug跟踪器项目).

当我在一年后看到你的差异时,在意识到它引入了一个微妙的错误后,我需要知道为什么要做出改变 - 如果我找不到一个好的理由,我只是要回滚它并诅咒你的懒惰方式...... ;-)

有意义的评论有几个目的:

如果您正在寻找版本历史记录中的特定更改,他们会让您快速浏览文件的历史记录(例如:"嘿,我知道我们在去年3月的某个时候修复了这个小部件闪烁的错误.你还记得吗？那是什么解决方案？").

他们鼓励你做出雾化提交.如果您最终使用通用注释进行签入,这可能意味着您一次做了太多事情.

如前所述,他们会让你知道为什么会发生变化.当然,差异可以告诉你,例如,税项计算如何改变项目等.但它不会告诉你,这是因为税法的XYZ法律发生了变化.

它们使编写发行说明或等效文档变得更容易.

也许有点不同的观点:

如果要查看一年或自上次发布以来的所有更改 - 是否要查看所有差异,或者您希望查看良好的提交注释和缺陷/问题项的链接？