JavaDoc生成文档

Java Doc

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

• 参数信息

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

• //通过命令行生成javadoc档：javadoc 参数 java文件（javadoc -encoding UTF-8 -charset UTF-8 Doc.java）

• 使用IDEA生成Javadoc文档：

  1. 首先创建一个存放JavaDoc的文件夹

  2. 然后在IDEA中打开目录点击Tools-Generate JavaDoc

  3. 接着在这里选择创建Demo1文件夹的位置

  4. 然后在Local行和编码集写下如下代码，即可设置为中文且防止了中文带来的乱码:

     Locale：zh_CN

     Other command line arguments： -encoding UTF-8 -charset UTF-8

  5. 点击"ok"后IDEA便会自动生成JavaDoc文档，注意下方的输入栏出现以下语句即代表生成完毕。

  6. 接下来在Demo01文件夹中找到index.html文件

  7. .打开后就会看到我们的JavaDoc文档了，会包含项目中的所有类和程序包。