Appearance
为了提高程序的可读性,最有效的方式之一是使用注释。注释是程序中的文本,说明了代码的作用。Java编译器在生成Java源代码文件的字节码版本时忽略注释,因此使用注释不会带来任何危害。
在Java程序中,可以使用3种不同的注释。
单行注释以两个斜杠//打头。从这些斜杠到行尾的所有内容都是注释。
多行注释以/打头,以/结束。这两个分界符之间的所有内容(可以横跨多行)都被视为注释,如下所示:
/*this program
your hand */
Javadoc注释以/**打头,以*/结束。
这些分界符之间的内容都被视为用于描述类及其方法的官方文档。
Javadoc注释可被诸如javadoc(JDK中的一个命令行工具)等实用程序读取。
javadoc使用这种注释来创建一组网页,用于说明Java类的功能、指出Java类在继承层次结构中的位置、描述其每个方法。
注意:Java类库中每个类的官方文档都是根据Javadoc注释生成的。