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生成到指定目录。