JavaDoc文件如何生成

目录

• 如何使用
  • 1.通过命令行生成JavaDoc文档
  • 2.IDEA如何配置后生成javadoc文档

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

参考信息：

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的JDK版本
• @param 参数名
• @return 返回值情况
• @throws 异常抛出情况

package com.tisto.Demo04;
/**
 * @author yangwenlong
 * @version 1.0
 * @since 1.8
 */

如何使用

1.通过命令行生成JavaDoc文档

打开CMD

输入javadoc -encoding UTF-8 -charset UTF-8 类名.class

在index文件中就有详细的文档。

2.IDEA如何配置后生成javadoc文档

• Frist

• Second

解释一哈：

1. 选择是整个项目还是模块还是单个文件
2. 文档输出路径
3. Locale 选择地区，这个决定了文档的语言，中文就是zh_CN
4. 传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

• Final

点击OK即可