Rne*_*net 2 c# java coding-style
可以记录代码更改的不同方法有哪些？我正在研究经历了很多变化的代码.记录代码更改的当前约定是类似的
//Begin add by xxxx for feature/bug xxxx <Date>
........
........
//End add by xxxxx for feature/bug XXXX <Date>
这种草率的评论方式产生了很多混乱.我们通过粗评论寻找实际的代码行.我们不想在版本控制软件的checkin-comments部分记录更改.我正在考虑在文件开头维护一个更改日志,其中记录了所有更改.你们用什么方法来记录这些变化？
Gre*_*ill 16
你会发现在实践中,重要的信息是代码现在所做的,而不是它是如何实现的.通过使用这些类型的注释来模糊当前代码,您使代码更难以阅读和使用.
在您需要返回并查看为何已完成某些操作的情况下,所有信息最好在版本控制中捕获.不要试图在代码本身中捕获历史记录.
您的版本控制系统应该是更改信息的主要来源.关于代码中非显而易见的功能的注释应记录为注释,无论原因如何,即是否为更改.
更改代码的程序员,作为更改原因的相关错误/功能以及更改的时间ALL已经编码在版本控制系统创建的文件的更改日志中!任何更多手动添加的更改日志,它将过时,并使文件混乱.