随着集成源代码控制的出现，存储过程的更改还需要注释吗？

Question

过去，我的团队有一个政策，任何存储过程修改都需要在两个地方进行注释：

1. 存储过程的顶部以及所做更改的总体摘要
2. 对进行更改的每一行的注释

它通常看起来像这样：

CREATE PROCEDURE usp_Test
/*****************************************************************
The purpose of this stored procedure is to get data.
Created by 8kb 2001-01-01
Modified: removed OR clauses from JOIN statement..8kb 2001-06-01
******************************************************************/
AS
BEGIN

SELECT * 
FROM t1
JOIN t2
ON t1.colA = t2.colA
-- Removed OR clause..8kb 2001-06-01
-- OR t1.ColB = t2.ColB

END

但是现在有了集成的源代码管理，我可以总结源代码管理中的变化，然后使用比较/差异功能来查看新旧版本之间的差异。

在作为集成源代码控制一部分的存储过程中编写逐行更改注释是否仍然有价值？

Answer 1

对于每个模块进行一次更改，这可能没问题，但是想象一下经过几年的开发，您的代码会是什么样子。

在普遍采用版本控制之前，曾经有 95% 的历史日志和只有 5% 的实际代码的模块。幸运的是，版本控制很久以前就自动消除了这种不便。

我会完全摆脱评论中的更改日志 - 我们使用现代工具效率更高。此外，git 和其他版本控制工具允许你做的不仅仅是查看一个文件的更改日志。例如，他们可以向您显示在同一提交中更改的所有其他文件。他们还为您提供准确的信息，而我们不能完全相信评论。