JavaDoc几个参数
1、java文档注释当中通常有如下几个参数:
1、@author :作者名
2、@version :版本号
3、@since :指明最早需要使用的jdk版本
4、@param :参数
5、@return:返回值情况
6、@throws:异常抛出情况
2、如何生成文档注释?
2.1 通过DOS命令生成文档注释
(1) 在IDEA中书写如下的示例代码:
/**
* 类文档注释JavaDoc
* @author zanxiang
* @version 1.0
* @since 1.8
*/
public class Doc {
String name;
/**
* @author zanxiang
* @param name
* @throws Exception
*/
public void test(String name)throws Exception{
this.name=name;
System.out.println("name is:"+name);
}
}
(2)进入文件夹
选择进入待生成文档注释类的文件夹
3、进入控制台,并定位到Doc文件夹下
在文件路径前边输入:cmd 即可进入Dos操作界面
4、输入命令
命令:javadoc +参数+文件名.java
5、返回Doc.java所在的文件夹路径下
双击打开index.html文件,即可查看所生成的JavaDoc文档。
2.2 通过IDEA集成开发环境生成JavaDoc文档
1、选中要生成文档的类,点击Tool(工具),选择生成 JavaDoc选项,如图:
2、进入到如下面板:
3、点击确定后,控制台出现如下的信息:
(4)打开文档保存的路径,打开API文档索引
双击打开index.html文件,即可查看所生成的JavaDoc文档。