06 JavaDoc

JavaDoc

既有官方的文档(api帮助文档),也可以自己生成.

---

生成方法:

1. 生成一个类

/**
* @author name
* @version 1.0
* @since 1.8 javaversion
*/

public class Doc{
	String name;
	
	/**
	* @ATU
	*@param name
	*@return
	*@throws Exception
	*/
	
	#以上内容在下面的函数写完,敲/**回车后,会自动生成
	
	public String test(String name) throws Exception{
		return name;
	}
}

2. 命令行(地址为这个包的文件夹下)

   javadoc -encoding UTF-8 -charset UTF-8 Doc.java
   #javadoc 参数 文件名
   

3. 在当前文件夹下会生成许多新文件,打开index.html即可查看网页

IDEA生成JavaDoc

1. 在IDEA上方栏中选择工具(tool)

2. 选择生成JavaDoc

   • 选择文件范围
   • 自定义输出目录
   • 区域设置为zh_CN
   • 设置命令行参数

3. 打开输出目录下的index.html即可查看