8.6.2　类、方法等注释的方法

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

1.类注释

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

/**

this is the student class.

it includes the student name.

*/

public class student

{

……

}

2.方法注释

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

❑@param变量描述

❑@return返回类型描述

❑@throws异常类描述

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

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