Day9JavadDoc文档的生成

JavaDoc命令是用来生成API文档的
参数信息如下：
@author作者名
@version版本号
@since指明需要最早使用的jdk版本
@param参数名
@return返回值情况
@throws异常抛出情况

package com.kuangshen.base;

/**

• @author kuangshen
• @version 1.5
• @since 1.8
  */

public class Doc {
String name;

/**
 *
 * @param name
 * @return
 * @throws Exception
 */

public String test(String name) throws Exception{
    return name;


}

}
文档注释中那些参数可以通过命令提示符的方式或IDEA中生成Javadoc文档来查看API文档
1.命令提示符

首先在图中找到explorer的选项，点击后会跳转到该类在文件夹中的路径，如图所示

之后再其文件路径之前加上cmd 后回车，调出命令提示符页面，输入代码：javadoc -encoding UTF-8 -charset UTF-8 Doc.java之后回车，文件夹中会多出相应文件的API文档，点击查看即可
如：

2.在idea中生成javadoc文档
首先找到工具类中生成javadoc的选项，如下图所示

点击后输入相关文件的路径点击确认即可，结果相同