[Java知识库]JavaDoc文档

JavaDoc

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

2. 参数信息：

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

3. 加在类上就是类的注释，加在方法上就是方法的注释

   

• 【/**】+【回车】即可快速生成注释

生产API文档

方法一：命令行生成

• 在文件夹中打开：右击类–>选择【open in】–>【Explorer】

• 在终端打开,输入指令

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

方法二：使用IDEA生成

• 选择菜单中【Tools】—>【Generate javaDoc】

• —【Custom scope】：自定义范围 —>选择【Open File】：当前打开的
• —【Output directory】：自定义输出目录
• —【Other command line arguments】中输入：

-encoding UTF-8 -charset UTF-8 -windowtitle "接口文档3.4" -link http://docs.Oracle.com/javase/7/docs/api

• 点击【OK】，即可到指定目录查看：

  — 出现下图情况不管

? — 双击打开【index.html】查看

成功！！！

代码

package operator;

/**
 * @author IT_Jay
 * @version 1.0
 * @since 1.8
 * @date 2021/12/8 8:20 PM
 */
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
    //通过命令行生产     javadoc 参数 java文件
}