自解释代码

最近在给同事们做code review的时候,发现需要反复强调代码自解释的概念,于是想写一篇文章专门说这个话题。 但今天搜到一个文章,已经很好的解释了什么是自解释代码,文章在 15 Ways to Write Self-documenting JavaScript,国内有人翻译了:如何编写更加自解释的代码

补充几点:

  1. 不及时更新的注释或者不正确的注释还不如没有。
  2. 如果一定要加注释,那么不要着重解释代码做了什么(what),而是要解释为什么要这么做(why)。而很多时候是可以通过函数封装,用函数名来解释这个why。
  3. 好的程序员会认为写自解释代码是天经地义,自然而然的事情。
  4. 再次推荐《Code Complete 》与《Clean Code》,《Refactoring》,这三本应该是每个程序员的必读书。