当前位置:  开发笔记 > 编程语言 > 正文

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

如何解决《配置管理-代码注释中的历史记录》经验,为你挑选了1个好方法。

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

我最近加入了一个新的软件开发小组,该小组使用Rational工具进行配置管理,包括源代码管理和变更管理系统.除了这些工具之外,团队还有一个标准做法,即在代码中注明任何代码更改,例如:

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

他们评论标准的官方目的是"评论提供从需求到代码修改的可追溯性".

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

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

我想知道是否有人不同意我的论点.我是否遗漏了注释源代码历史的一些好处,即管理和源代码控制系统无法提供变更?



1> Dan Breslau..:

对于我自己,我总是发现这样的评论比它们的价值更麻烦:它们可能导致合并冲突,当你试图隔离两个版本之间的差异时可能会出现'误报',并且可能引用代码更改从那时起,后来的改变已经废弃了.

在不丢失元数据的情况下,通常(并非总是,但经常)可以更改版本控制系统.如果您要将代码移动到支持此功能的系统,在切换之前编写脚本以将更改历史记录转换为注释并不困难.

推荐阅读
手机用户2402852307
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有