JavaDoc生成文档

JavaDoc

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

package com.runze.base;

/**
 * @author run
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

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

注：加在类上是类的注释，加在方法上面是方法的注释