相信大家都已经看过了不少说明文档，例如Java API、Android API，它们无疑都是这样的：
最初的时候，我也很好奇它是怎么来的，就以为像平常的参考书一样，都是别人一字一笔制作出来的。但是，等我认识到javadoc这个东东的时候，我才发现，可以差不多是一键就能生成这种文档了。。。
其实缘由可以由我们最初学习Java注释的时候看出，我们都知道，Java注释分为三种：行注释（//）、段落注释（/* */）、文档注释（/** */），为什么称为文档注释？其中，其重要功能之一，便是用于生成HTML说明文档。
本文将讲解两部分：
1、使用cmd命令窗口对一个java文件进行生成文档说明
2、使用eclipse对于一个项目进行生成文档说明
1、使用cmd命令窗口对一个java文件进行生成文档说明
（1）首先，我们应该在磁盘中创建一个java文件，例如：E:\HelloJavaDoc.java
里面的大致内容如下：
- /**
- * 测试JavaDoc
- *
- * @author xiejinxiong
- *
- */
- public class HelloJavaDoc{
- public static void main(String[] args){
- output("Hello JavaDoc!");
- }
- /**
- * 简化输出语句
- *
- * @param obj
- * 所需要输出的内容
- */
- public static void output(Object obj) {
- System.out.println(obj.toString());
- }
- }
图示：
便可以发现E:\路径下出现了一大堆网页文件，这时，我们只需要打开index.html文件即可，便可以发现网页内容：
是不是觉得和官方文档API很像呢，而且我们写的文档注释都显示了出来。（是不是感觉好简单呢(●'◡'●)）
（3）不过，先别着急，我们思考一下，javadoc可以将java文件中的文档注释生成为html文件并显示出来，那么，假如我们在java文件的文档注释中添加网页的标签呢，那会怎么样呢，于是，把E:\HelloJavaDoc.java文件的内容修改一丢丢：
- /**
- * 测试JavaDoc
- * <ul>
- * <li>第一行</li>
- * <li>第二行</li>
- * <li>第三行</li>
- * </ul>
- * @author xiejinxiong
- *
- */
- public class HelloJavaDoc{
- public static void main(String[] args){
- output("Hello JavaDoc!");
- }
- /**
- * 简化输出语句
- *
- * @param obj
- * 所需要输出的内容
- */
- public static void output(Object obj) {
- System.out.println(obj.toString());
- }
- }
然后再进行（2）步骤，打开重新生成的index.html文件
我们将发现，我们所使用的html标签生效了，说明javadoc生成html时，只是将文档注释中的*号去除，保留了里面的内容，因此，我们可以通过这个功能，使得我们的说明文档变得更加炫酷。（(●'◡'●)这就要考考你编写前端的能力了）
以上便是生成单个Java文件的说明文档的方法，但是，这并不能满足我们的需求，我们更加需要的是将自己所做的项目进行生成整个说明文档。
2、使用eclipse对于一个项目进行生成文档说明
（1）新建一个Java or Android 项目。
（2）右键项目名-->Export-->Java\Javadoc--Next >-->finish
图示：
引用地址:http://blog.csdn.net/u011596810/article/details/50825748