【Java】Java Doc

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

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

加在类上就是类的注释，加在方法上就是方法的注释
方法的注释打出/**+回车就会自动出来下方的注释

package com.base;
/**
 * @author yao
 * @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;
    }
}

如图↓↓，点击进入文件所在位置

然后输入cmd加一个空格，回车进入命令行的界面

---

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

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

就会自动生成Java文档

然后在目录中查看，新生成许多文件

总结

javadoc 参数 java文件
其中，-encoding UTF-8 -charset UTF-8 是为了文档规范美观，防止部分中文乱码

麻烦麻烦！亲自上手哦！
感谢ლ(°◕‵ƹ′◕ლ)！！！