java基础12.JavaDoc生成文档

12.JavaDoc生成文档

JavaDoc

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

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

package operator;
//类注释
/**
 * @author SHEN
 * @version 1.0
 * @since 1.8
 */
public class doc {
//方法注释（先写这段方法，再/**+enter,自动注释了一些信息）
    /**
     * @author SHEN
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{//方法
        return name;
    }
}

打开文件夹

1.地址头部输入cmd

或者覆盖地址栏输入cmd

或者按shift右键击文件夹空白处就有在此处打开命令窗回

2.javadoc -encoding UTF-8 -charset UTF-8 Doc.java把java文件编译成一份文档

这是通过命令行javadoc 参数 java文件

javadoc java生成文档

加参数：为了多显示一点中文。万一遇到乱码问题，可以解决。
-encoding UTF-8文档中如果有中文就设置编码(encoding-编码)为UTF-8
-charset UTF-8字符集编码也是UTF-8

打开文件夹中生成的index.html（即 首页）

作业:搜索 使用IDEA生成Java.Doc文裆!