javaDoc

javaDoc

首先记住一个网站:JDK帮助文档

package com.yh.base;

//加在类上面就是类的注释

/**
 * @author yh
 * @version 1.5
 * @since 1.8
 */



public class Doc {
    String name;//    属性

    //加在方法上面就是方法的注释

    /**
     * @author yh
     * @param name
     * @return
     * @throws Exception
     */


    public String test(String name)throws Exception{    //    方法
        return name;
        //老师通过命令行生成
        //学会查找使用 IDEA 生成javaDoc文档
        //不会问百度
    }
}

打开 Doc 所在的位置，在位置名前输入cmd 进入命令行，输入

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

执行