写评论是件坏事吗?

Is writing comments a bad thing?

我一直在阅读一篇文章 "summary of Clean Code"。

其中提到的一点是"One of the most common reasons for the comments is because the code is bad"

我多年前了解到,写评论是一种很好的协作实践,可以让从事该项目的其他人清楚地了解 class/function/code 块中发生的事情,等等通过阅读评论。我一直都知道在团队中这样做是深思熟虑的。

我想澄清一下。

我认为这两种情况都有可能发生。您可能有充分的理由评论或评论只是试图使混乱的代码易于理解。

即使是最干净的代码(不是 "bad" 代码)也可以从一些注释中获益。这些可能对以下方面很有用:

  • 指出完成整个过程主要步骤的代码部分
  • 说明为什么在函数调用中使用某些值不是很直观
  • 帮助新协作者轻松理解您的代码结构(例如,使用开源代码)
  • 指出在实践中以不同方式执行某些程序时的技术细节

现在,这与你引用的句子并不矛盾。这句话并不意味着每次有评论都是因为代码不好。它只是说糟糕的编码是使用注释的一个很可能的原因,我觉得这在某种程度上是直观的。编写 "good" 代码需要 more/better-developed 技能,而不是编写 "bad" 代码,因此可能有更多的人编写 "bad" 代码并试图用评论来填补空缺人们用严格有用的注释编写整洁的代码。

因此,回答您的问题,我认为不能说写评论本身就是一件坏事。依靠评论来尝试和纠正错误的编码做法是一件坏事。