coding-style - 配置管理 - 代码注释中的历史记录

Question

在问我的问题之前，让我先介绍一些背景信息:

我最近加入了一个新的软件开发小组，该小组使用 Rational 工具进行配置管理，包括源控制和变更管理系统。
除了这些工具之外，团队还有一个标准做法是将任何代码更改作为代码中的注释进行记录，例如:

///<history>
   [mt] 3/15/2009  Made abc changes to fix xyz
///</history>

他们对注释标准的官方目的是“注释提供从需求到代码修改的可追溯性”。

我准备提出一个论点，即这种做法是不必要和多余的；团队应该立即摆脱这个标准。

也就是说 - 变更管理系统是建立从需求到代码修改的可追溯性的地方，源代码控制可以通过在版本之间执行差异来提供详细的变更历史。 checkin 源代码时，会记录相应的变更管理票证。解决 CM 票证后，我们会记录修改了哪些源代码文件。我相信这为所需的可追溯性提供了足够的交叉引用。

我想知道是否有人不同意我的论点。我是否错过了更改管理和源代码控制系统无法提供的注释源代码历史记录的一些好处？

Answer 1

就我自己而言，我总是发现这样的评论比它们的值(value)更麻烦:它们会导致合并冲突，当您尝试隔离两个版本之间的差异时可能会显示为“误报”，并且可能会引用代码更改后来的变化已经过时了。

通常(并非总是，但经常)可以在不丢失元数据的情况下更改版本控制系统。如果您要将代码移动到 的系统中没有 支持这一点，在切换之前编写一个脚本将更改历史转换为注释并不难。