JavaDoc的学习

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

什么是API

API就是帮助文档

下面给出Java jdk的api连接

参数信息

@author
@version
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

实际操作一波

package com.Gemin.base;

/**
 * @author Gemin
 * @version 1.0
 * @since  14.0.2
 */
public class Doc {
    public String name;

    /**
     *
     * @author Gemin
     * @param name
     * @return String
     * @throws Exception
     */

    public String getname(String name)throws Exception{
        return name;
    }
}

上面是自己随便写的一段代码，没有意义，只是为了演示生成的api