JavaDoc

JavaDoc

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

参数信息：

@author 作者名

@version版本号

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

@param参数名

@return返回值情况

@throws异常抛出情况

package com.zj.base;

/**
 * @author zj
 * @version 1.0
 * @since 1.8
 *
 */
public class Doc {
    String name;

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

生成API文档的方法

1、dos命令

打开文件所在位置，在路径最前方输入cmd+空格，然后回车即可打开命令提示符窗口，再输入命令：

回车后会自动生成html文件，打开后即可查看

打开index.hml查看

2、利用IDEA生成

1）在idea工具栏选择Tools—》Generate JavaDoc…

2)在弹出的窗口中选择要生成文档的文件或项目