JavaDoc

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

  • 参数信息：

  1. @author 作者名

  2. @version 版本号

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

  4. @param 参数名

  5. @return 返回值情况

  6. @throws 异常抛出情况

  • 通过命令行生成JavaDoc文档：
javadoc -encoding UTF-8 -CHARSET UTF-8 Doc.java
  • 通过IDEA生成JavaDoc文档：

  1. 打开 idea，点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。

  2. 进行配置：

图片

标注的是重要的部分，从上往下分别是配置 javadoc 的范围，输出文件夹路径以及命令行参数。

这里的命令行参数很重要，因为只有使用 utf-8 编码才能保证生成时可以正常处理中文字符，所以一定要加上：

-encoding utf-8 -charset utf-8

还可以配置那些注解需要生成，哪些权限类（private、package、protected、public）需要生成等等精细的控制。

还有一点需要注意，即不要勾选“Include test sources”，勾选后，生成时会造成很奇怪的错误。

  1. 配置好后，点击生成按钮，生成好后就会自动在浏览器打开进行查看咯，是不是很棒O(∩_∩)O~