8.6 注释及嵌入文档

注释对于读懂程序起着不可缺少的作用，一个程序的可读性是否好，关键就是注释。对于一个程序的二次开发而言，要想读懂前面的程序代码，首先要在程序中有大量的注释文档。

本节将介绍如何对代码进行注释。通过实例来证明注释在开发工作中的重要地位。前面曾经提到过注释，读者也许印象不太深，这里也算复习一遍。

8.6.1 如何添加注释

如何添加注释呢？一般使用下面的方法。

/＊＊
包名引用
＊/

这个是类和包、方法的注释，下面将详细地介绍这些注释。

8.6.2 类、方法等注释的方法

在这一小节中，将简单地介绍类、方法、字段等的注释方法，虽简单但是很重要。

1. 类注释

类注释一般必须放在所有的“import”语句之后，紧靠在类声明之前。

/＊＊
this is the student class .
it includes the student name.
＊/
public class student
{
...
}

2. 方法注释

方法注释必须紧靠在方法声明的前面，除了/**...*/标签外，还可以使用下列的以@开始的标签。

❑@param变量描述

❑@return返回类型描述

❑@throws异常类描述

如果以上的注释都没有，把程序拿给别人看，别人会轻易看懂吗？如果过了很长时间以后，自己再来看看这些程序，可能也已经忘记这些代码是做什么的了。

所以说，注释对于程序的可读性来说，是非常重要的，希望读者不要忽视它，以免造成无可挽回的损失。