JavaDoc知识点学习(遗漏的冷门知识点)

JavaDoc知识点学习(遗漏的冷门知识点)

简介

javaDoc命令是用来自动生成java api文档的，通过使用一些参数，可以自动生成api文档，可以写自己的类然后生成自己的java文档

参数介绍

测试类Talk

/**
 * 
 * @author Mr.whr
 * @version 1.0
 * @since 1.8
 */
public class Talk {
	/**
	 * 
	 * @param name
	 * @return 测试用例
	 * @throws Exception
	 */
	public String startTalk(String name) throws Exception {
		TalkLib talk=new TalkLib();
		Map<String,String> m=talk.getMap();
		return "1";
	}
}

1. @author: 作者名
2. @version：版本号
3. @since：最低需要的jdk版本号
4. @param： 参数名
5. @return：返回值的含义
6. throws：异常抛出情况
   
   
   
   

生成javaDoc文档演示

1、生成的java文件

2、打开cmd窗口，并进入到桌面，输入javaDoc命令

3、设置编码格式，使生成的api文档不显示乱码

4、在同级目录下生成相应api文档，以html格式显示，点击index.html文件即可访问

总结

java代码的参数设置中不能出现中文，否则会报错无法生成javadoc文档，例如 “@return 测试用例”

可以通过doc命令生成javadoc文档，同时也可以通过ide集成工具生成文档