JavaDoc命令入门

Posted 2021-06-16 Ryan伊凡

JavaDoc命令

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

 

/**+回车

参数信息

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

IDEA中：在方法上直接输入/**+回车，可直接生成方法的注释

在类上直接输入/**+回车，可直接生成类的注释

 

/**
 * @author Ryan
 * @version 1.0
 * @since 1.0
 */
​
​
​
public class doc {
    String name;
​
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

 

生成API文档

---

1. 在IDEA中，选择要生成API文档的类，右击，选择open in explorer

2. 在地址栏(盘符)前加上cmd空格后回车，进入命令行模式

3. javadoc -encoding UTF-8 -charset UTF-8 doc.java

• • encoding：选择UTF-8进行编码
  • charset：使用UTF-8字符集
  • 为了编译不产生乱码

• 生成的文件中index.html就是API文档了

在IDEA中生成API文档

---

1. 选中要生成API文档的项目、模块、类，在菜单栏选则tools–>Generate javaDoc…

2. 设置输出路径和编码格式（-encoding utf-8 -charset utf-8）