Java(TM) 支持三种类型的注释文档工具,如下表所示。
javadoc 功能非常强大。由 Sun 发行的标准 Java 包括用 javadoc 生成的文档;因此,学习此工具的一个好方法是一边学习包含了注释(这些注释被 javadoc 转换为 Html 文档)的 Java 源代码,一边参考那些 HTML 文档。
注释示例 说明
int x; // a comment 一行中"//"后的部分为注释内容
/*
The variable x is an integer:
*/int x; “/*” 和 “*/”之间的所有内容为注释内容,编译器对此注释内容不做处理
/**
x -- an integer representing the x coordinate
*/
int x; “/**”和“*/”之间的所有内容为注释内容,编译器对此注释内容不做处理,此种注释为文档工具 javadoc 生成文档时所用