使用Javadoc导出项目的API文档

2015.01.19 13:10 Mon | 314次阅读 | java

本文系转载,原文地址

概述

技术文档是项目的重要组成部分,Javadoc则是Java技术文档的基础之一。Javadoc为Java代码生成一组便于使用的API文档,作为沟通工具,这些文档可提供有益的帮助,使团队成员理解其他成员正在进行的工作。

当然,要获得良好的Javadoc文档,要求源代码中有精心编写的有意义的注释,对任何工具而言,这都是苛刻的要求。这不是本文的重点内容。

本文将具体讲述使用Eclipse开发工具导出项目的Javadoc文档的步骤和常见的问题。

步骤

1.根据Javadoc文档的说明标准,对项目中的类、接口等文件精心编写注释

2.选中要生成javadoc的项目,右键->Export(导出)。选择Java->javadoc,点击Next>。

Image

3.分别选择如下选项,点击Next。

javadoc command:设置javadoc命令的路径。

select types for which javadoc will be generated:选择需要生成的项目

Create javadoc for members with visibility:选择生成文档的类和方法的访问范围。

Destination:选择生成文档的目标目录。

Image

4.在Documenet title中填入生成文档的名称,其它选择默认,点击Next。

如图

Image

5.在VM options中填入-encoding utf-8 -charset utf-8,具体的编码方式,根据你的项目

的编码方式决定。点击Finish。

注意:如果编码方式不对,会出现编码错误报错!!!

Image

6.然后,有Eclipse生成文档。

Image

可能出现的错误

1.在导出Android项目的时候,出现android.os包不存在等报错时,是由于项目无法

找到Android的jar包而引起的。项目邮件->property->Java build path->Order and Export,勾选其中导入的包,就可以解决此问题。

2.在生成文档的时候,出现GBK编码无效的报错时,是由于Java默认使用GBK编码,

与你的项目冲突导致的,在导出中文文档的时候这个问题尤为突出,在生成文档想到中,注意在VM options中填入-encoding utf-8 -charset utf-8。可以解决此问题。