Java 如何将程序中的注释提取出来生成说明文档

第一种方法：

可以使用JavaDoc工具。它可以从程序源码中将类、方法、成员变量等文档注释抽取出来形成一个与源代码配套的API帮助文档。但是在编写代码时要以一定的规范做注释才可以。通过JavaDoc实现工具就可以同时生成代码的开发文档了。JavaDoc工具位于 C:\Program Files\Java\jdk1.6.0_10\bin 路径下。

其中/**...*/这种注释用于支持JavaDoc工具，还有一些以@开头的标识信息也可以抽取出来，如下图。

这里使用源码中StringBuffer.java 文件为例。

打开控制台窗口，首先进入StringBuffer.java的目录，这里放在c盘test目录下。

执行javadoc StringBuffer.java

如下图

如果报无法找到命令，请确认安装JDK时是否配置了环境变量。

生成的文件如下。

打开文件就会看到类似于Java API样式的说明文档。

第二种方式：

借助eclipse实现。

在项目列表中按右键，选择Export，然后在Export对话框中选择java下的javadoc，下一步。在Javadoc Generation对话框中：javadoc command:应该选择jdk bin 目录下的javadoc.exedestination:为生成文档的保存路径。finish提交即可开始生成文档。

 欢迎访问我的博客