文档注释and生成API文档

package com.chen.base;
//文档注释
/**
 * @author cyy
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     * @author cyy
     * @param name
     * @return
     * @throws Exception
     */
    public  String test(String name) throws Exception{
        return name;
    }
    /*
    @author 作者名
    @version 版本号
    @since 指明需要最早使用的JDK版本
    @param 参数名
    @return 返回值情况
    @throws 异常抛出情况
     */
    
/* 生成API(帮助文档)的两种方法: 法一:用IDEA自带工具:点击tool,选择generate javadoc 法二:命令行窗口生成javadoc */

 

 


}

 

posted @ 2022-04-09 11:36  胖虎9  阅读(57)  评论(0)    收藏  举报