评论代码或不评论代码

时间:2012-10-09 16:47:08

标签: comments

我曾在多家公司工作,在每个地方,人们对是否应将评论纳入代码有不同的意见。有人说他们不应该这样做,因为程序员的代码应该足够简单易懂,因此应该自我评论。他们进一步争辩说,因为代码经常变化,开发人员并不总是勤奋地更新评论及其代码,评论很快就会过时,从而变得误导。另一组说,代码的功能是用技术术语来描述系统的功能,但它并不总是描述代码的业务原因是什么,因此注释对于给出上下文的上下文是有用的。码。我倾向于倾向于前一种观点。我想知道社区的意见是什么。请分享你的想法。

谢谢,

萨钦

1 个答案:

答案 0 :(得分:1)

我同意你的看法。业务原因应该在验收测试中捕获,或者,如果您的类型系统足够强大以表达它们,则直接在类型系统中进行机械检查。

与业务规则同样重要的事情肯定属于评论,评论既不检查也不执行也不测试。