javaDoc文档

javaDoc文档

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

#参数信息：需要使用文档注解表达参数

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

 

---

 

#命令行生成javaDoc文档

• 文件夹导航栏cmd 进入命令行

• javadoc（命令） -encoding utf-8 -charset utf-8 （参数）doc.java（生成文档位置）

• 打开文件夹点击index.html即可查看

 

---

 

#idea生成javaDoc文档

/*使用IDEA生成javaDoc文档
*新建一个文件夹用于存放生成的Doc文档
* 打开idea菜单栏找到 tools - GenerateJavaDoc
* 找到Output directory：选择刚刚新建的文件夹
* 接着在下面的Locale： 输入zh_CN代表中文
* Other command line arguments: 输入-encoding utf-8 -charset utf-8
* 点击确定等待生成javaDoc文档即可，打开文件夹找到index.html文件点开就可以看到生成的API文档
* */