代码中的更多注释或只是简单,可读,可维护的代码就足够了？

有时很难确定你何时为某人写了足够的评论来理解你的意图.

我认为人们需要更多地关注编写可读,易于理解的代码,而不是包含大量的注释,解释所发生的每一个细节.

你对此有何看法？

评论不能解释你在做什么.他们在那里解释你为什么要这样做.

这个论点是基于一个错误的困境:你的代码是一个可怕的憎恶,你写了大量的评论来解释每一个陈述和表达,或者你的代码是美丽的诗歌,你的祖母可以理解,没有任何文件.

实际上,你应该为后者而努力(好吧,也许不是你的祖母而不是其他开发人员),但是我们意识到有时几条评论会清除歧义,或者使接下来的十行代码更加清晰.主张不发表评论的人是极端分子.

当然,应该避免无偿的评论.没有任何评论可以帮助更糟糕的代码更容易理解.他们可能只是让事情变得更糟.但除非你只编写琐碎的系统,否则有时候评论会澄清正在做出的设计决策.

这在捕获错误时很有用.识字代码看起来完全合法,而完全错误.没有评论,其他人(或者你六个月后)不得不猜测你的意图:你的意思是这样做,还是意外？这是错误,还是在其他地方？也许我应该参考设计文档...评论是内联文档,可以在您需要的地方看到.

正确地确定何时需要评论是关键.

尝试使代码自我解释.最重要的事情之一是为类,函数,变量等使用有意义的名称.

评论那些不能自我解释的部分.琐碎的评论(例如i ++; //将1添加到i)会使代码更难阅读.

顺便说一下 - 你可以越接近伪代码,你的代码就会越自我解释.这是高级语言的特权; 很难自我解释汇编代码.