comments - 评论代码或不评论代码

Question

我在不同的公司工作过，在每个地方，人们对代码中是否应该包含注释都有不同的看法。有人说他们不应该这样做，因为程序员的代码应该足够简单易懂，因此应该是自我注释的。他们进一步争辩说，由于代码经常更改，并且开发人员并不总是足够勤奋地更新注释以及他们的代码，因此注释很快就会过时并因此变得具有误导性。另一组说代码的功能是用技术术语描述系统做什么，但它并不总是描述代码的业务原因是什么，因此注释有助于为系统提供上下文。代码。我倾向于倾向于前一种观点。我想知道社区的观点是什么。

谢谢，

萨钦

Answer 1

我同意你的看法。业务原因应该在验收测试中捕获，或者，如果您的类型系统足够强大来表达它们，那么直接在编译器可以机械检查它们的类型系统中。

像业务规则这样重要的东西绝对不属于评论，评论既不检查也不执行或测试。