javaDoc文档导出

代码注释十分重要，但利用率却很低，如何將代码中的注释与开发过程紧密结合，实现程序员规范注释习惯，可以通过Doc进行注释检查以及作为项目文档。接下来简单介绍一下javaDoc导出。

第一步：编写合理注释

这就是一个简单的测试用的java项目，里面有一个用于测试list转json的测试方法。

第二步：导出

右键项目-->导出，选择javadoc，单击下一步。

选择要导出的项目以及导出类别(可以使用默认)

配置自变量(默认就行)

在这一步，导出格式默认GBK，如果你的项目编码格式是UTF-8那就要加上这一句：

-encoding UTF-8 -charset UTF-8

 

在生成时发现另一个类中的doc方法注释param没有添加详细说明，所以建议在使用javadoc导出时搭配checkStyle一同使用。

但并不影响doc的生成

在项目目录下多了一个doc文件夹。打开真实路径我们可以看一下html

打开index.html我们就可以看到这个项目的整体java代码结构了。