写评论是一件坏事吗? [关闭]

问题描述 投票:-1回答:1

我一直在阅读文章“清洁代码摘要”。

提到的要点之一是“引起注释的最常见原因之一是因为代码错误”

[几年前,我了解到编写注释是进行协作的一种好习惯,并且使其他从事该项目的人清楚阅读类/函数/代码块中正在发生的事情等是很清楚的。评论。我一直都知道在团队内部这样做很周到。

我想对此进行澄清。

coding-style comments
1个回答
2
投票

我认为这两种情况都可能发生。您可能有正当的理由,也可能只是想使混乱的代码变得可理解。

即使最干净的代码(不是“不好的”代码)也可以从一些注释中受益。这些在许多其他方面很有用:

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

现在,这与您引用的句子并不矛盾。该句子并不意味着每次都有注释是因为代码不正确。它只是说不良的编码是使用注释的一个很可能的原因,我觉得这很直观。比起制作“不良”代码,它需要更多/更好的技能来制作“良好”代码,因此与严格制作整洁代码的人相比,制作“不良”代码并试图用注释填补漏洞的人可能更多有用的评论。

因此,请给出一个[[回答您的问题],我认为有人不能说发表评论本身就是一件坏事。依靠注释来尝试并纠正错误的编码做法将是一件坏事。

© www.soinside.com 2019 - 2024. All rights reserved.