生成Doc文档

package base;
// /**是注解  //是注释
/**
 * @author Zhaomouren(作者名）
 * @version 1.0     （版本）
 * @since 1.8       （需要最早使用的jdk版本）
 */
//加在类上是类注释
public class Doc {

    String name;

    /**
     *@author Zhaomouren
     * @param name 参数名
     * @return 返回值情况
     * @throws Exception 异常抛出情况
     */
    //加在方法上面是方法注释
    public String test(String name) throws Exception{
        return name;
    }
}

    用Idea生成Doc文档

package operator;

/**
 * @author zhaomouren
 * @version 20.22
 * @since 6.17
 */
public class Work01 {
    static double salary = 1500;

    String name;
    int age;

    /**
     * @param args
     */
    public static void main(String[] args) {
        int a = 10;
        System.out.println(a);

        Work01 work01 = new Work01();
        System.out.println(work01.name);
        System.out.println(work01.age);
        System.out.println(salary);

        final double PI = 3.14;

        System.out.println(PI*10);
    }

    public void add(){
        int a = 20;
        System.out.println(a);
    }
}
首先第一步，写代码（如上）
第二步，点击Tools->Generate JavaDoc

 

 

 

 一般就能自动生成了

搜索

复制