文档注释是具有多行注释外观的特殊注释,区别在于它们生成源代码的外部文档。
它们以正斜杠开头,后跟两个星号,以星号结尾,后跟一个正斜杠。
例如:
/**这是一个文档注释*/ /**这也是一个 文件注释*/
Javadoc是JDK附带的一个工具,它用于从Java源代码生成HTML格式的Java代码文档,Java源代码具有预定义格式的所需文档。
当文档注释以两个以上的星号开头时,Javadoc假设您希望在源代码中的注释周围创建一个"框"。它只是忽略了额外的星号。
例如:
/********************** 这是一种方法的开始 ***********************/
这将只保留文档中的文本"这是方法的开始"。