sql-server - 我是否正确评论了这部分查询？

Question

我觉得这值得好评，但我觉得我所拥有的只是一种干扰。

1. 这值得评论吗？
2. 如果是，是否可以改进此评论？

请注意，我正在使用规范化程度很低的应用程序。

(   
    /* Remove Time Portion From ActivityDate */  
    DateAdd(Day, DateDiff(Day, 0, Activity.ActivityDate), 0) Not Between        
    /* Remove Time Portion From @MinimumDate Or SQL Server Min DateTime */   
    DateAdd(Day, DateDiff(Day, 0, Coalesce(@MinimumDate, '1753-01-01')), 0) And
    /* Remove Time Portion From @MaximumDate Or SQL Server Max DateTime */  
    DateAdd(Day, DateDiff(Day, 0, Coalesce(@MaximumDate, '9999-12-31')), 0) 
)

Answer 1

就我个人而言，我认为您不需要这样的注释:removes X from Y 或 increments X by Y 等等...

话虽这么说，如果您觉得需要对代码的特定部分进行注释，我会尽量将重点放在功能的意图和大局上。例如，为什么要这样实现？这样，下一个跟在你后面的人在必须做出改变时就有了战斗的机会。

例如，我知道您的代码片段在功能上有什么作用，但我不知道它为什么存在或它与应用程序的其余部分有何关系。可能的改进可能是向刚接触代码的人或可能不关心如何实现但为什么的人解释功能>.

我总是要提醒自己，编程就是交流，您向其他程序员传达您的意图越清楚，您的情况就会越好。如果您能找到一种方法来添加评论以提高开发人员之间的沟通质量，那就去做吧。我认为，那些准确地告诉您代码正在做什么的注释最终会适得其反，并且会损害沟通。