记录代码更改

时间:2012-04-19 19:38:57

标签: c# java coding-style

可以记录代码更改的不同方法有哪些? 我正在研究经历了很多变化的代码。记录代码更改的当前约定类似于

//Begin add by xxxx for feature/bug xxxx <Date>
........
........
//End add by xxxxx for feature/bug XXXX <Date>

这种草率的评论方式产生了很多混乱。我们通过粗评论寻找实际的代码行。我们不想在版本控制软件的checkin-comments部分记录更改。我正在考虑在文件开头维护一个更改日志,其中记录了所有更改。你们用什么方法记录这些变化?

3 个答案:

答案 0 :(得分:16)

您会发现,在实践中,重要信息是代码现在的内容,而不是它是如何实现的。通过使用这些类型的注释来模糊当前代码,您使代码更难以阅读和使用。

在您需要返回并查看为什么已完成某些操作的情况下,所有信息最好在版本控制中捕获。不要试图在代码本身中捕获历史记录。

答案 1 :(得分:5)

您的版本控制系统应该是更改信息的主要来源。关于代码中非显而易见的功能的注释应记录为注释,无论原因如何,即是否为更改。

更改代码的程序员,作为更改原因的相关错误/功能以及更改的时间ALL已经编码在版本控制系统创建的文件的更改日志中!任何更多手动添加的更改日志,它将过时,并使文件混乱。

答案 2 :(得分:4)

我永远不会在代码中这样做。永远不能。 注释应该是最小的,并且只能使代码中的混淆逻辑更清晰(或者更常见的是指出约定)。始终单独提交每个更改。写一个简洁的max 79chars提交消息。您可以保留重组文本 - 例如CHANGES.rst - 在每个数据包(产品)的根目录中。我们就是这样做的 - 你可以看看here

您还可以使用ticketing / pm系统并在提交消息中提及票证。