生成 JavaDoc 文档

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。在简略介绍JavaDoc写法之后，再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。

java中的注释有三种：

1. 单行注释：在IDEA中快捷键为Ctrl+/

2. 多行注释：在IDEA中快捷键为Ctrl+Shift+/

3. 文档注释：

   @author 作者名

   @version 版本号

   @since 指明需要最早使用的jdk版本

   @param 参数名

   @return 返回值情况

   @throws 异常抛出情况

生成javadoc文档两种方式

javadoc命令

javadoc命令是用来生成自己API文档的

1.打开IDEA，右键要生成文档的类hello，打开其所在文件夹位置。

2.在该文件夹里打开命令窗口。

3.输入命令 javadoc -encoding utf-8 -charset utf-8 hello.java，也就是javadoc + 参数 +java类 。

4.完成。

 

直接在IDEA中生成javadoc

1.IDEA菜单栏的tools，选中Generate JavaDoc。

2.点击OK完成。

 

最后生成的API文档