java入门-1-5-JavaDoc

JavaDoc

javadoc 用来生成自己的文档

package operator;
/**
 * @author  sasa
 * @version 1.0  版本号
 * @since 1.8  指明需要最早使用的jdk版本
 */
public class JavaDoc {

    String name;

    /**
     * @author  sasa
     * @param name
     * @return
     * @throws Exception
     */
    public  String doc(String name)throws Exception{
        return name;
    }
}

通过cmd命令生成文档

可以通过javadoc -encoding UTF-8 -charset UTF-8 JavaDoc.java -d file mypackage.txt
这个命令 是在cmd中运行给源文件生成文档
-encoding UTF-8 -charset UTF-8 是为了防止乱码
JavaDoc.java 是需要生成文档的源文件
-d flie 是新建名字为file的文件夹 生成的文档就在这个文件夹内

不加-d name 文档就是和源文件在同一个文件夹内
生成的文件中的index.html 实在网页中查看文档

注意：记得是在源文件的类的路径内输入cmd

java文档下载地址

https://docs.oracle.com/javase/8/docs/api/