会写注释才是合格的程序员

前言

上一篇中我们讲了命名，今天我们来讲一下注释（Comments）。注释其实就是针对复杂逻辑代码的解释和说明，解释为什么要这么写，这段代码大概功能是什么。注释的作用是方便阅读代码的人快速理解编写代码的人的思考。

注释

命名很重要，注释跟命名同等重要。很多书籍认为，好的命名完全可以替代注释。如果需要注释，那说明命名不够好，需要在命名上下功夫，而不是添加注释。实际上，我个人觉得，这样的观点有点太过极端。命名再好，毕竟有长度限制，不可能足够详尽，而这个时候，注释就是一个很好的补充。

1. 注释到底该写什么？

注释的目的就是让代码更容易看懂。只要符合这个要求的内容，你就可以将它写到注释里。总结一下，注释的内容主要包含这样三个方面：做什么、为什么、怎么做。我来举一个例子给你具体解释一下。

/**

* (what) Bean factory to create beans.

*

* (why) The class likes Spring IOC framework, but is more lightweight.

*

* (how) Create objects from different sources sequentially:

* user specified object > SPI > configuration > default object.

*/

public class BeansFac