9、JavaDoc

JavaDoc

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

  语法：/** 文档注释 */

• 参数信息

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

JavaDoc用法演示：

package com.zws.base;

/**
 * @author ZhaoWenshuai
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

对于写好了文档注释的.java文件我们可以生成相应的文档。
以下为命令行下生成JavaDoc的命令：

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

此命令需要先定位到“Doc.java”的目录，或者指明“Doc.java”的绝对路径

文件正在生成......

可以看到目录下生成了一些新的文件，我们打开 index.html 看下

效果还是不错的 Y(^_)Y

终端中我们会使用了，那么我们来看下IDEA中更简单的方法。

IDEA --> Tools(工具) --> Generate JavaDoc(生成 JavaDoc)

选择好生成JavaDoc的范围，输出文件目录以及参数（编码），确定即可