Java实用教程
上QQ阅读APP看本书,新人免费读10天
设备和账号都新为新人

2.6 注释语句

在Java源文件的任意位置,都可以加入注释语句,Java编译器会忽略程序中的注释语句。Java语言提供了3种形式的注释。

(1)//java annotation——从“//”到本行结束的所有字符均作为注释而被编译器忽略。

(2)/*java annotation*/——从“/*”到“*/”间的所有字符会被编译器忽略。

(3)/** java annotation*/——从“/**”到“*/”间的所有字符会被编译器忽略。

Sun公司为JDK开发工具包提供了完整的JDK文档说明,JDK文档中提供了Java中的各种技术的详细资料,以及JDK中提供的各种类的用法说明。

对于用户创建的Java类,如何编写这种html格式的javadoc文档呢?JDK中提供了一个javadoc.exe程序,它能够识别Java源文件中符合特定规范的注释语句,根据这些注释语句自动生成javadoc文档。在Java源文件中,只有满足特定的注释才会构成javadoc文档。这些规范包括:

(1)注释以“/**”开始,并以“*/”结束,里面可以包含普通文本、html标记和javadoc标记。

(2)javadoc命令只处理Java源文件中在类声明、接口声明、成员方法声明、成员变量声明及构造方法声明之前的注释,忽略位于其他地方的注释。