mik*_*era 5 ruby documentation comments commenting
我回顾了一些用Ruby编写的专业代码,没有发现任何评论.代码相当清楚,但不能自我记录.我应该期待专业编写的Ruby代码有评论吗？或者,是否有一些Ruby学说,评论不被认为是必要的？
这个问题并不是Ruby特有的.
代码注释应保持绝对最小值,因为它们通常在代码更改时不会更新,并且变得更具误导性而不是有用.
正如您已经建议的那样,最好的代码是自我记录,不需要任何评论.
编辑:澄清一下,如果无法减少代码以消除复杂性,则必须提供注释.这在我的经验中很少见,并且通常仅在外部组件的行为不像您期望的那样适用.
Matz,Ruby的创建者,在这里和那里陈述他的哲学:"源代码是文档.它甚至正确地说明了所有的错误." 他也可能意味着评论.我想许多不在Ruby源代码中发表评论的人都在听他的话.你是否跟随他取决于你.
我还阅读了一些Ruby介绍性网站,他们说,每当你觉得有必要发表评论时,这表明你应该按照个别方法分割该例程,并将其命名为评论该部分.
| 归档时间： |
|
| 查看次数： |
487 次 |
| 最近记录： |