Java文档注释

java的文档注释

1.简介

java有3种注释

• 单行注释
• 多行注释
• 文档注释

单行注释和多行注释和C、C++是相同的，文档注释是不同的，文档注释是通过JDK中的javadoc生成的。

2.操作展示

java的文档注释的格式如下

/**
@author Frank
@version
这是我的java程序
*/

jdk中的javadoc会解析文档注释，然后生成网页来展示这个java文件

使用javadoc解析的命令行如下

javadoc -d forldername -author -version -encoding UTF8 filename.java

• forldername 是指定解释文档的生成位置
• filename 是需要对文档注释进行解析的java程序文件

具体展示
javadoc -d myHello -author -version -encoding UTF8 HelloWorld.java

• 点击index.html即可查看解析文档