本文讲解 Java 中的注释以及文档 ~

---

1. 注释

1.1 引言

1.1.1 何为注释？

• 在我看来，注释无非是对一行或多行代码作的解释罢了。它能让读者很快地明白这段代码的含义，一个好的注释可以极大地增强代码的可读性。以下这段代码是我曾在 C 语言专栏中写下的，学过 C 语言的朋友对这段代码定不陌生，其中的 /* */ 中的一堆，称为多行注释，// 后的那一句称为单行注释。 这些注释都会被编译器忽略，不会执行，仅仅是为了给人看。
  
• 因此，我对注释的理解就两字 “解释”，即让看代码的人很快地明白这一堆代码是什么意思？有什么用？怎么用？…

1.1.2 注释有何用？

1. 看下图中的代码，弄明白这段代码的含义并估摸自己用了多长时间
   
2. 加上注释以后，再次看这段代码，就可以体会到看似不起眼的几句话，却对快速地理解代码有着极大的好处。因此，写好注释也是作为一个优秀程序员必备的素养，既方便了自己，也方便了别人
   

1.2 类注释

1.2 方法注释

---

2. 文档