利用eclipse生成API文档

制作目的：

提供了很多官方的介绍和类、方法、变量的解释。由于我主要是做Android开发，还提供自己封装的一些公用方法和组件。如果开发人员对正在使用的类不熟悉，想查看类里面的变量或者方法，就可以打开JavaAPI文档进行阅读和查看。很多开发语言都提供了官方的文档，可以让开发人员迅速地提高能力。

生成方法：

1.打开Eclipse，点击工程，选择project - Generate Javadoc，如图：

     

2.在弹出的对话框中，选择 需要生成帮助文档的类，也可以选择 工程中所有的类。    

3.选择导出的路径， 路径确定 点击finish。

                                    

4.在对应的路径下 就可以 找到刚才导出的文件了。      

5.查看文档

可能遇到的问题

问题一：ECLIPSE生成JAVADOC时出错：编码GBK的不可映射字符

由于java源代码是用的UTF-8编码，Eclipse中默认编码是GB18030，因此，在生成javadoc的时候，需要手工指定一下编码和字符集。

解决方案是：

主菜单–>Project–>Generate javadoc–>next>next–> 在 “Extra javadoc options”下面的文本框中填入 ” -encoding UTF-8 -charset UTF-8 “.

          

问题二：eclipse导出android项目javadoc时报NullPointerException异常

导出的时候报如下错误
标准 Doclet 版本 1.6.0_43
正在构建所有软件包和类的树...
java.lang.NullPointerException
    at com.sun.tools.javadoc.TypeMaker.getType(TypeMaker.java:67)
    at com.sun.tools.javadoc.TypeMaker.getType(TypeMaker.java:29)
    at com.sun.tools.javadoc.ClassDocImpl.superclassType(ClassDocImpl.java:439)
    at com.sun.tools.doclets.internal.toolkit.util.Util.getAllInterfaces(Util.java:386)
    at com.sun.tools.doclets.internal.toolkit.util.Util.getAllInterfaces(Util.java:424)
    at com.sun.tools.doclets.internal.toolkit.util.ClassTree.processType(ClassTree.java:162)
    at com.sun.tools.doclets.internal.toolkit.util.ClassTree.buildTree(ClassTree.java:114)
    at com.sun.tools.doclets.internal.toolkit.util.ClassTree.(ClassTree.java:73)
    at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:104)
    at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
    at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
    at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
    at java.lang.reflect.Method.invoke(Method.java:597)
    at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
    at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
    at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
    at com.sun.tools.javadoc.Start.begin(Start.java:128)
    at com.sun.tools.javadoc.Main.execute(Main.java:41)
    at com.sun.tools.javadoc.Main.main(Main.java:31)
解决方法
copy 一个android.jar 到项目libs 目录下 就可以了。
android.jar 在：\sdk\platforms\android-19下 我用的19开发的项目，所以导19android.jar包

                                                   觉得好用点个赞，有问题进qq群（左上角）交流或者是留下评论。