在优秀的Ruby代码中没有评论是否可以接受？

Question

我查看了一些用Ruby编写的专业代码，但未发现任何评论。代码相当清楚，但不能自我记录。我应该期待专业编写的Ruby代码有评论吗？或者，是否有一些Ruby学说认为评论不重要？

Answer 1

这个问题不是Ruby特有的。

代码注释应保持绝对最小值，因为它们通常在代码更改时不会更新，并且变得更具误导性而非有用。

正如您已经建议的那样，最好的代码是自我记录，不需要评论。

编辑：澄清一下，如果您无法减少代码以消除复杂性，那么必须提供评论。根据我的经验，这种情况很少见，通常仅在外部组件的行为不符合您的预期时才适用。

Answer 2

Ruby的创建者Matz在这里和那里陈述了他的哲学：“源代码是文档。它甚至正确地陈述了所有的错误。”他也可能意味着评论。我想许多不在Ruby源代码中发表评论的人都在听他的话。无论你是否跟随他，都取决于你。

我还阅读了一些Ruby介绍性网站，他们说，只要你觉得有必要发表评论，那就表明你应该按照个别方法分割那个例程，并将其命名为你要对该部分进行评论。