JavaDoc

JavaDoc

avadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

javadoc命令是用来生成自己API文档的。

格式

@author 作者名

@version 版本号

@since 指明需要的最早的jdk版本

@param 参数名

@return 返回值

@throws 异常抛出情况

使用方式：使用命令行在目标文件所在目录输入javadoc +参数+文件名.java。

IDEA生成JavaDoc

IntelliJ IDEA 12.1.版本，就提供了很好的 JavaDoc 生成功能，以及标准 JavaDoc 注释转换功能，其实质是在代码编写过程中，按照标准 JavaDoc 的注释要求，为需要暴露给使用者的类、方法以及其他成员编写注释。然后使用 IDEA 的功能自动调用 javadoc.exe（JDK 自带的工具）根据源代码中的注释内容自动生成 JavaDoc 文档（超文本格式）。这里有几点倒是要特别注意一下：

1.IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。

2.里面有一个 Locale 可选填项，建议在此填写 zh_CN。

3.还有一个“Other command line arguments:”可选填项，非常重要，是填写直接向 javadoc.exe 传递的参数内容。因为有一些重要的设置，只能通过直接参数形式向 javadoc.exe 传递。这里必须要填写如下参数：

-encoding UTF-8 -charset UTF-8 -windowtitle "接口文档3.4" -link http://docs.Oracle.com/javase/7/docs/api

直接上图

4.点击OK即可将javadoc生成到指定目录。

Het-1621128294615)]

4.点击OK即可将javadoc生成到指定目录。

原文链接