Java Doc生成文档

Java Doc文档

package com.bai.base;

/**
 * @author kuangshen 作者
 * @version 1.0   版本号
 * @since 1.8  版本
 */
public class Doc {
    String name;

    /**
     *
     * @param name//参数
     * @return
     */
    public String test(String name){
       return name;
    }
//注：Doc文档写在 类/方法 上方
    /**
     * @author kuangshen
     * @param name
     * @return
     * @throws Exception  抛出异常
     */
    public String test(String name) throws  Exception{
        return name;
    }

    /**
     * 总结
     * @author 作者名
     * @version 版本号
     * @since 指明需要最早使用的jdk版本
     * @param 参数名
     * @return 返回值情况
     * @throws 异常抛出情况
     */
    //通过命令行：javadoc -encoding UTF-8 -charset UTF-8 Doc.java
    //格式：javadoc 参数 Java文件
    //生成Index网页等
}

此文章整理自https://www.bilibili.com/video/BV12J41137hu?p=31，B站[狂神说java]视频。全篇本人自个儿整理，若有不足欢迎指出，我会加以补充。