JavaDoc
javadoc命令是用来生成自己API文档的
参数信息
@author 作者名
@version 版本号
@since 指明需要最早使用的JDK版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
用例
/**
* @author DN
* @version 1.0
* @since 1.8
*/
public class Doc{
String name;
/**
* @author DN
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
使用IDEA生成JavaDoc文档
点击Tools>Generate JavaDoc
Generate JavaDoc scope
这个用于选择需要生成的目标文件或项目
Output directory
用于指定生成的doc文件存放位置
Locale
选填项 ,表示生成的文档以何种语言展示,默认为英文或当前系统语言,若要生成中文版本则填写 zh_CN
Other command line arguments
可选填项,非常重要,是填写直接向javadoc.exe 传递的参数内容。因为有一些重要的设置,只能通过直接参数形式向 javadoc.exe 传递,这里必须要填写如下参数:
-encoding UTF-8 -charset UTF-8 -windowtitle "你文档在浏览器窗口标题栏显示的内容" -link http://docs.Oracle.com/javase/7/docs/api
完成
测试生成文档
找到之前生成文档时设置的存放文件夹,用浏览器打开 index.html 文件即可