JavaDoc用法

JavaDoc用法

-----------------------------------------------------------------------------------------------------------------

用法：javadoc [options] [packagenames] [sourcefiles] [@files]



Options Description

-overview <file>
读取 HTML 格式的概述文档

-public
仅显示 public 类和成员

-protected
显示 protected/public 类和成员（缺省）

-package
显示 package/protected/public 类和成员

-private
显示所有类和成员

-help
显示命令行选项

-doclet <class>
通过候选 doclet 生成输出

-docletpath <path>
指定 doclet 类文件的查找位置

-1.1
利用 JDK 1.1 模仿 doclet 生成输出

-sourcepath <pathlist>
指定源文件的查找位置

-classpath <pathlist>
指定用户类文件的查找位置

-bootclasspath <pathlist>
覆盖自举类加载器所加载的类文件的位置

-extdirs <dirlist>
覆盖已安装的扩展的位置

-verbose
有关 Javadoc 所做工作的输出信息

-locale <name>
所用的 Locale，例如 en_US 或 en_US_WIN

-encoding <name>
源文件编码名称

-J<flag>
将 <flag> 直接传给运行时系统

由标准 doclet 提供：

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

-use
创建类和包的用法页

-version
包含 @version 段

-author
包含 @author 段

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

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

-doctitle <html-code>
包含包索引页（首页）的标题

-header <html-code>
包含每一页的页眉文本

-footer <html-code>
包含每一页的页脚文本

-bottom <html-code>
包含每一页的页底文本

-link <url>
创建到 javadoc 输出的链接（位于 <url>）

-linkoffline <url> <url2>
利用位于 <url2> 的包列表链接到位于 <url> 的文档

-group <name> <p1>:<p2>..
将概览页中指定的包分组

-nodeprecated
不包含 @deprecated 信息

-nodeprecatedlist
不生成不鼓励使用的列表

-notree
不生成类层次

-noindex
不生成索引

-nohelp
不生成帮助链接

-nonavbar
不生成导航栏

-helpfile <file>
包含帮助链接功能链接到目标的文件

-stylesheetfile <path>
改变所生成文档的样式的文件

-docencoding <name>
输出编码名称



javadoc工具可以从java源文件中解析出类、方法以及/**...**/注释，产生HTML文档，采用与JDK的API文档相同的格式。我们可以采用这个工具很方便的生成专业的说明文档。javadoc.exe包含在标准的JDK中。

javadoc工具可从下列对象中提取出信息：包、公共类、公共接口、公共或受保护方法、公共或受保护变量/常数。

http://aofengblog.blog.163.com/blog/static/631702120062171113540/

一. Java 文档

// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行，并写入 javadoc 文档

通常这种注释的多行写法如下：

/**
* .........
* .........
*/

二. 文档注释的格式

1. 文档和文档注释的格式化

生成的文档是 HTML 格式，而这些 HTML 格式的标识符并不是 javadoc 加的，而是我们在写注释的时候写上去的。
比如，需要换行时，不是敲入一个回车符，而是写入 <br>，如果要分段，就应该在段前写入 <p>。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)，而是读取每一行后，删掉前导的 * 号及 * 号以前的空格，再输入到文档的。如

/**
* This is first line. <br>
***** This is second line. <br>
This is third line.
*/


2. 文档注释的三部分
先举例如下

/**
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值
*/
public void show(boolean b) {
frame.show(b);
}

第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。

第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行

简述也在其中。这一点要记住了

第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值

三. 使用 javadoc 标记
javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些：
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明

@author 作者名
@version 版本号
其中，@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次，只有第一次有效

使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。@param 描述方法的参数，@return 描述方法的返回值，@exception 描述方法可能抛出的异常。它们的句法如下：
@param 参数名 参数说明
@return 返回值说明
@exception 异常类名 说明


例如：

/**

* The doGet method of the servlet.

* This method is called when a form has its tag value method equals to get.

*

* @param request The request send by the client to the server

* @param response The response send by the server to the client

* @throws ServletException if an error occurred

* @throws IOException if an error occurred

*/

public void doGet (HttpServletRequest request, HttpServletResponse response)

throws ServletException, IOException {

doPost(request, response);

}

http://blog.163.com/a13151055695@126/blog/static/1120870742009102411840679/?fromdm&fromSearch&isFromSearchEngine=yes