Eclipse下用javadoc导出Android项目的帮助文档（一）

使用Eclipse生成文档（javadoc）的步骤：

1. 在项目列表中按右键，选择Export

2. 在Export对话框中选择java下的javadoc

3. 在Javadoc command:应该选择jdk的bin/javadoc.exe

4.在Create Javadoc for members with visibility: 下选择要对哪些生成API文档，Public ,Private... 每选择一个都会有相应提示，选择你要的。如果选择private，所有类都会有一个对应的html，如果选public，可能只有一部分。

Public: Generate Javadoc for public classes and members.
Private:Generate Javadoc for all classes and members.

Protected:Generate Javadoc for protected and public classes and members.

Package:Generate Javadoc for all but private classes and members.

5. 在destination设置生成文档的保存路径

6. 按finish(完成)提交即可开始生成文档

解读doc下生成的html：

1.如果类中有enum,会另外单独生成一个html，

• 每个枚举都有各自的页面, 其中包含以下部分:

  • 枚举声明
  • 枚举说明
  • 枚举常量概要
  • 枚举常量详细资料

比如IDCard.java类中有一个枚举Side, 那么会生成IDCard.html和IDCard.Side.html。

同样IDCardRecognizer.java类中有一个枚举Mode,那么会生成IDCardRecognizer.html和IDCardRecognizer.Mode.html.

容易发生的问题：

1. “编码 GBK 的不可映射字符” 错误

这是由于javadoc读取你代码文件时编码格式不一致造成的。在上述步骤的第五步后，继续进入到下一步，找到“Extra Javadoc options ..."，在里面加入相关的编码支持，比如你用的是utf-8编码就填上 “ -encoding UTF-8 -charset UTF-8 ”

2. “软件包 android.*** 不存在” 错误

这是由于javadoc找不到android.jar造成的。在你工程的 .classpath文件加上android.jar包的位置，例如：

path是你的android.jar的位置

 <classpathentry kind="lib" path="E:/SDK/android-sdk-windows/platforms/android-10/android.jar"/>

转自:http://blog.csdn.net/thinkinwm/article/details/16120131