JavaDoc

首先，Java帮助文档网址https://docs.oracle.com/javase/8/docs/api/

javadoc命令是用来生成自己的API文档
参数信息：
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

package com.kun.test.base;

/**
 * @author kunLin
 * @version 1.0
 * @since 1.8
 */

public class DocDemo_01 {

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