Java基础-JavaDoc生成文档

JavaDoc

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

 

• 参数信息

  • @author 作者名

  • @version 版本号

  • @since 指明需要最早使用的jdk版本

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

     

package com.wang.base;
​
/**
 * @outhor Wang
 * @version 1.0
 * @since 1.8
 */
public class Doc {
​
    String name;
​
    /**
     * @author Wang
     * @version 1.0
     * @since 1.8
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

【狂神说Java】Java零基础学习视频通俗易懂-哔哩哔哩