一周技术思考（第21期）-人们说脏话的频率是衡量代码质量的唯一标准

大家好，这里记录，我每周读到的技术书籍、专栏、文章以及遇到的工作上的技术经历的思考，不见得都对，但开始思考总是好的。

Bob大叔在《代码整洁之道》这本书中，曾说过，“人们说脏话的频率是衡量代码质量的唯一标准”，对这个“标准”大家是不是有自己的经历呢。

 

那如果不想说脏话，或者不想被别人说脏话，我们又应该怎样做呢。

 

写出的代码能让人快速理解、轻松维护、容易扩展的程序员，肯定是最受欢迎的程序员。

 

程序员之间的互相尊重就体现在他所写的代码中。

 

那如何成为上面说的那样的程序员呢，写好注释，行不行呢。

 

今天，就让我们用这篇文章，来谈一谈这个问题。

 

在为代码写注释这件事上，一直就存有两派，一派是注释派，一派是代码派。

 

我们先来说说注释派的观点或主张。

 

代码说不清，注释来补充

 

大家都会写注释的，对吧（你可能会笑）。

 

我们除了要把代码写的清晰之外，还需要记得适当地，合理地增加注释。

 

如果你的代码写的不清晰，那么你更应该增加注释，几个月后，前来接收代码的程序员会十分地感谢你，而，那个程序员也很有可能是你自己。

 

图自《编写可读代码的艺术》

 

当程序员看到一个类文件或者一段方法的头部注释信息，可以立马能知道如何使用它，很可能当时就用不着再去阅读下面的代码，留个印象就好了，可以去干别的相关联的工作，回来再看。

 

如果一个方法内，有注释，就可以告诉你的下一个开发人员，如何修复或者扩展这些代码。

 

利人利己，好事一桩。

 

你可能会说，我的代码已经写的很简洁，而且清晰易懂，那当然是再好不过的事情了。我们也是一直提倡，尽可能的用代码来表达可能多的意思。

 

而注释的作用，是把那些代码还没有说清的描述出来。

 

代码能表达的含义与你想表达的全部含义之间总会有些差距，用来弥补其中不足的注释都可以被看作有用的注释。