本文目录一览：
如何使用eclipse生成javadoc帮助文档
首先，打开Eclipse，在需要生成Javadoc的项目上右击鼠标，在弹出来的列表中点击”导出(O)…“选项。
在弹出来的”导出“窗口中，选择导出的目标，这里选择Java文件夹下的Javadoc，然后点击”下一步（N）“按钮。
进入到”选择生成Javadoc的类型“界面，这里默认已经配置好了生成Javdoc的javadoc.exe的路径，如果不对可以重新配置，在“使用标准Doclet(S)”一栏中选择输入Javadoc的目录，默认实在工作空间工程项目下的doc文件夹中，也可以自行配置，然后点击”下一步（N）“按钮。
进入到”配置标准doclet的Javadoc自变量“界面，可以根据需要配置Javadoc的自变量，可以通过”基本选项“下的复选框来选择Javadoc选项。如果想引用一个库中的类，并且将该库链接到它的javadoc，可以在“选择应将链接生成至的被引用归档和项目（R）”列表中选择，然后点击“下一步（N）”按钮。
进入到“配置Javadoc自变量”界面，这里注意：如果项目采用的是UTF-8编码，Extra Javadoc options（额外的Javadoc选项）下需要输入设定参数：-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码，点击“完后”按钮。
在点击“完成”按钮后，会看到Eclipse主界面的“控制台”输入Javdoc生成成功的信息。
查看生成的Javadoc帮助文档。
进入到工作空间对应的工程项目下，可以看到有个doc文件夹（当然这是默认的输出目录，如果你在生成Javadoc时设置了其它目录，可以进相应的目录中）。
点击进度doc文件夹，会发现doc文件夹中有好多.html文件，打开index.html文件。
可以看到生成的API文档，这里面显示了过程中的相应信息。
点击其中的类，可以看到相应类的信息，如你设置的版本、作者，还可以看到继承的类等信息，有助于快速了解源代码。
如何使用javadoc
package com.frank.chapter1;
// object.Documentation1.java
// TIJ4 Chapter Object, Exercise 13 – 1
/* Run Documentation1.java, Documentation2.java and Documentation3.java
* through Javadoc. Verify the resulting documentation with your Web browser.
*/
/** A class comment */
public class Documentation1 {
/** A field comment */
public int i;
/** A method comment */
public void f() {
}
}
如上一段代码，使用了javadoc的注释形式，注释以/** 开始, 以*/ 结尾，注释写在要说明部分的前面。
如何生成javadoc呢？ 很简单，在eclipse中点击导航栏中的 project-Generate javadoc 跳出如下界面，然后勾选需要生成文档的包以及生成文档的位置就OK啦！~
更详细的说明见转载
以下转自：
通常我们写java程序可能很少会写注释的，但是在公司里真正开发项目的时候。通常都会有严格的文档要求，我这里谈到的不是设计或者测试文档，而是javadoc。我一直认为javadoc察看起来比MSDN要方便，写起来同样不复杂。
javadoc是j2sdk里面一个非常重要的工具，如果你按照规范在java的源代码里面写好注释的话，那么它就可以生成相应的文
档。开发者察看起来会非常方便。很多IDE都可以直接生成javadoc的，这里介绍如何写javadoc以及如何在eclipse下生成
javadoc。
javadoc通常从package、公开类或者接口、公开或者受保护的字段、公开或者受保护的方法提取信息。每条注释应该是以/**开始以*/结尾。例如
/**
*
* @param id the coreID of the person
* @param userName the name of the person
* you should use the constructor to create a person object
*/
public SecondClass(int id,String userName)
{
this.id = id;
this.userName = userName;
}
注释应该写在要说明部分的前面，如上所示。并且在其中可以包括html的标记，如果上面没有标记
的话，那么you should usr the ……将会在javadoc里面紧跟@param userName….，这样不是我们希望的。一般注释可以分为类注释、方法注释、字段注释等。下面分别作简单的介绍
类注释
类注释应该在import语句的后面在类声明的前面，比如
package com.north.java;
/**
* @author ming
*
* this interface is to define a method print()
* you should implements this interface is you want to print the username
* @see com.north.ming.MainClass#main(String[])
*/
public interface DoSomething
{
/**
* @param name which will be printed
* @return nothing will be returned
*
*/
public void print(String name);
}
其中@author 和@see都是常用的注释 第一个表示作者，第二个表示参考的连接。
2.方法注释
方法注释要紧靠方法的前面，你可以在其中使用@param @return @throws等标签。例如
/**
*
* @param i
* @return true if ….. else false
* @throws IOException when reading the file ,if something wrong happened
* then the method will throws a IOException
*/
public boolean doMethod(int i) throws IOException
{
return true;
}
3.字段注释
只有public的字段才需要注释，通常是static德，例如
/**
* the static filed hello
*/
public static int hello = 1;
在eclipse中我们新建java
project然后编写几个接口和类以后就可以用javadoc生成文档了，从菜单project选择generate
javadoc，会出现一个向导，你按照他的提示一步一步的设定要求，最好他会问你是不是声称一个javadoc.xml，如果选择生成的话，他会在
doc下产生一个javadoc.xml，以后更新文档的时候你可以直接用ant运行javadoc.xml。选择完成后你可以发现在project里面
出现了一个目录doc里面就是你的javadoc,想写出好的javadoc一个非常好的办法就是多参考java的api
doc。养成一个好的编程习惯非常重要，何况这并不难。
JAVA中JAVADOC是什么意思？
javadoc就是通过源代码(根据代码类包等的关系加注释)生成的api文档，可以是html的网页形式也可以打包成chm格式
JDK JavaDoc有什么用
JDK是一个工具包，里面包括很多高级Java开发时需要用到程序库和调试工具，比如虚拟机监控工具、内存工具、编码工具、打包工具、文档工具等等。其中的javadoc就是文档工具，用来自动根据代码中的带有特定格式的注释来生成HTML格式的文档。典型的一个例子就是Java官网的API解释。这些文档就是根据Java源代码中的注释自动生成的。
原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/276077.html
微信扫一扫 
支付宝扫一扫 