javadoc,javadoc注释规范

本文目录一览：

• 1、如何使用eclipse生成javadoc帮助文档
• 2、javadoc的具体使用方法，谢谢
• 3、JDK JavaDoc有什么用
• 4、如何使用javadoc命令生成api文档，文档注释
• 5、JAVA中JAVADOC是什么意思？
• 6、如何使用javadoc

如何使用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的具体使用方法，谢谢

用法：javadoc [选项] [软件包名称] [源文件] [@file]

-overview 文件 读取 HTML 文件的概述文档

-public 仅显示公共类和成员

-protected 显示受保护/公共类和成员（默认）

-package 显示软件包/受保护/公共类和成员

-private 显示所有类和成员

-help 显示命令行选项并退出

-doclet 类 通过替代 doclet 生成输出

-docletpath 路径 指定查找 doclet 类文件的位置

-sourcepath 路径列表 指定查找源文件的位置

-classpath 路径列表 指定查找用户类文件的位置

-exclude 软件包列表 指定要排除的软件包的列表

-subpackages 子软件包列表 指定要递归装入的子软件包

-breakiterator 使用 BreakIterator 计算第 1 句

-bootclasspath 路径列表 覆盖引导类加载器所装入的

类文件的位置

-source 版本 提供与指定版本的源兼容性

-extdirs 目录列表 覆盖安装的扩展目录的位置

-verbose 输出有关 Javadoc 正在执行的操作的消息

-locale 名称 要使用的语言环境，例如 en_US 或 en_US_WIN

-encoding 名称 源文件编码名称

-quiet 不显示状态消息

-J标志 直接将 标志 传递给运行时系统

通过标准 doclet 提供:

-d directory 输出文件的目标目录

-use 创建类和包用法页面

-version 包含 @version 段

-author 包含 @author 段

-docfilessubdirs 递归复制文档文件子目录

-splitindex 将索引分为每个字母对应一个文件

-windowtitle text 文档的浏览器窗口标题

-doctitle html-code 包含概述页面的标题

-header html-code 包含每个页面的页眉文本

-footer html-code 包含每个页面的页脚文本

-top html-code 包含每个页面的顶部文本

-bottom html-code 包含每个页面的底部文本

-link url 创建指向位于 url 的 javadoc 输出

-linkoffline url url2 利用位于 url2 的包列表链接至位于

档

-excludedocfilessubdir name1:..排除具有给定名称的所有文档文件子目

-group name p1:p2..在概述页面中，将指定的包分组

-nocomment 不生成描述和标记，只生成声明。

-nodeprecated 不包含 @deprecated 信息

-noqualifier name1:name2:…输出中不包括指定限定符的列表。

-nosince 不包含 @since 信息

-notimestamp 不包含隐藏时间戳

-nodeprecatedlist 不生成已过时的列表

-notree 不生成类分层结构

-noindex 不生成索引

-nohelp 不生成帮助链接

-nonavbar 不生成导航栏

-serialwarn 生成有关 @serial 标记的警告

-tag name:locations:header 指定单个参数自定义标记

-taglet 要注册的 Taglet 的全限定名称

-tagletpath Taglet 的路径

-charset charset 用于跨平台查看生成的文档的字符集。

-helpfile file 包含帮助链接所链接到的文件

-linksource 以 HTML 格式生成源文件

-sourcetab tab length 指定源中每个制表符占据的空格数

-keywords 使包、类和成员信息附带 HTML 元标记

-stylesheetfile path 用于更改生成文档的样式的文件

-docencoding name 输出编码名称

JDK JavaDoc有什么用

JDK是一个工具包，里面包括很多高级Java开发时需要用到程序库和调试工具，比如虚拟机监控工具、内存工具、编码工具、打包工具、文档工具等等。其中的javadoc就是文档工具，用来自动根据代码中的带有特定格式的注释来生成HTML格式的文档。典型的一个例子就是Java官网的API解释。这些文档就是根据Java源代码中的注释自动生成的。

如何使用javadoc命令生成api文档，文档注释

使用javadoc命令生成api文档：

创建java源文件包。java文件都是存放在一个package包中，这样方便对java文件进行操作和区分，首先在磁盘上创建文件夹一样的方式创建package包。

创建java源文件。在包下，创建与文件名相同的java源文件，输入一些文档注释，这些文档注释用于自动的api文件进行说明使用。

进入java源文件目录。通过cd等windows命令进入java源文件包所在的磁盘位置。

查看javadoc命令使用说明。如果是第一次使用javadoc命令，可以通过javadoc -help命令查看javadoc使用说明。

开始创建api文件。使用命令输入javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author javadoc/Hello.java 进行文档生成。-d:文件存储位置; -head:文件头部名称; -version:显示版本; -author:显示作者; javadoc/Hello.java 处理的文件包以及java源文件。

查看生成的api文件。创建成功之后，就会自动创建指定的文件夹下生成api文件。打开index.html就是api文件的入口。

JAVA中JAVADOC是什么意思？

javadoc就是通过源代码(根据代码类包等的关系加注释)生成的api文档，可以是html的网页形式也可以打包成chm格式

如何使用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。养成一个好的编程习惯非常重要，何况这并不难。