(1)文档注释的格式化

生成的文档是 HTML 格式，而这些 HTML 格式的标识符并不是 javadoc 加的，而是我们在写注释的时候写上去的。比如，需要换行时，不是敲入一个回车符，而是写入 ＜br＞，如果要分段，就应该在段前写入 ＜p＞。

因此，格式化文档，就是在文档注释中添加相应的 HTML 标识。

文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)，而是读取每一行后，删掉前导的 * 号及 * 号以前的空格，再输入到文档的。

如

 /** * This is first line. ＜br＞ ***** This is second line. ＜br＞ This is third line. */  

编译输出后的 HTML 源码则是 This is first line. ＜br＞ This is second line. ＜br＞ This is third line.

前导的 * 号允许连续使用多个，其效果和使用一个 * 号一样，但多个 * 号前不能有其它字符分隔，否则分隔符及后面的 * 号都将作为文档的内容。

还有一点需要说明，文档注释只说明紧接其后的类、属性或者方法,如:

/** commnet forclass */
public classTest { }

(2)文档注释的三部分

根据在文档中显示的效果，文档注释分为三部分。先举例如下，以便说明。

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

1.第一部分是简述

列表中属性名或者方法名后面那段说明就是简述。简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。如上例中的 “* show 方法的简述.”。

有时，即使正确地以一个点号作为分隔，javadoc 仍然会出错，把点号后面的部分也做为了第一部分。为了解决这个问题，我们可以使用一个 ＜p＞ 标志将第二分部分分开，如上例的“* ＜p＞show 方法的详细说明第一行 ....”。

2.第二部分是详细说明部分

该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。

3.第三部分是特殊说明部分

这部分包括版本说明、参数说明、返回值说明等。第三部分在上例中相应的代码是：

* @param b true 表示显示，false 表示隐藏

* @return 没有返回值

除了 @param 和 @return 之外，还有其它的一些特殊标记，分别用于对类、属性和方法的说明。

快速写注释的小窍门：在注释或方法注释前输入“/**”，按ENTER键，开发软件会自动的将param和return帮你加载出来，只用将对应 参数的功能介绍下就可以了，建议程序员最好是在开发的过程中就将注释写好，形成一个良好的编程习惯。

(3)使用 javadoc 标记

javadoc 标记是插入文档注释中的特殊标记，它们用于标识代码中的特殊引用。javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成。记住了，三个部分——@、标记类型、专用注释引用。虽然 @ 和 标记类型之间有时可以用空格符分隔，但是推荐将它们紧挨着写，以减少出错机会。

javadoc 标记有如下一些：

1 注释块标记

1.1 标记的顺序

块标记将采用如下顺序：

/** * @param (classes, interfaces, methods and constructors only) * @return (methods only) * @exception (@throws is a synonym added in Javadoc 1.2) * @author (classes and interfaces only, required) * @version (classes and interfaces only, required. See footnote 1) * @see * @since * @serial (or @serialField or @serialData) * @deprecated (see How and When To Deprecate APIs) */

View Code

一个块标记可以根据需要重复出现多次，多次出现的标记按照如下顺序：

/*** @author 按照时间先后顺序（chronological） * @param 按照参数定义顺序（declaration） * @throws 按照异常名字的字母顺序（alphabetically） * @see 按照如下顺序：* @see #field * @see #Constructor(Type, Type...) * @see #Constructor(Type id, Type id...) * @see #method(Type, Type,...) * @see #method(Type id, Type, id...) * @see Class * @see Class#field * @see Class#Constructor(Type, Type...) * @see Class#Constructor(Type id, Type id) * @see Class#method(Type, Type,...) * @see Class#method(Type id, Type id,...) * @see package.Class * @see package.Class#field * @see package.Class#Constructor(Type, Type...) * @see package.Class#Constructor(Type id, Type id) * @see package.Class#method(Type, Type,...) * @see package.Class#method(Type id, Type, id) * @see package */

View Code

1.2 标记介绍

1.2.1 @param标记

@param后面空格后跟着参数的变量名字（不是类型），空格后跟着对该参数的描述。

在描述中第一个名字为该变量的数据类型，表示数据类型的名次前面可以有一个冠词如：a,an,the。如果是int类型的参数则不需要注明数据类型。例如：

/*** @param ch the char 用用来…… * @param _image the image 用来…… * @param _num 一个数字…… */

View Code

对于参数的描述如果只是一短语，最好不要首字母大写，结尾也不要句号。 
对于参数的描述是一个句子，最好不要首字母大写，如果出现了句号这说明你的描述不止一句话。如果非要首字母大写的话，必须用句号来结束句子。（英文的句号） 
添加ByRef和ByVal两个标记，例如：

/*** @param _image the image ByRef 用来……*/

说明该参数是引用传递（指针），ByVal可以省略，表示是值传递。

1.2.2 @return标记

返回为空（void）的构造函数或者函数，@return可以省略。 
如果返回值就是输入参数，必须用与输入参数的@param相同的描述信息。 
必要的时候注明特殊条件写的返回值。

1.2.3 @throws 标记

@throws以前使用的是@exception。 
@throws的内容必须在函数的throws部分定义。

1.2.4 @author标记

类注释标记。 
函数注释里面可以不出现@author。

1.2.5 @version

类注释标记。 
函数注释里面可以不出现@version

1.2.6 @since

类注释标记。 
标明该类可以运行的JDK版本 
例如： 
@since JDK1.2

1.2.7 @deprecated

由于某种原因而被宣布将要被废弃的方法。

/**
* @deprecated As of JDK 1.1, replaced by
* setBounds
* @see #setBounds(int,int,int,int)
*/ 

3.2.8 @link标记

语法：{@link package.class#member label} 
Label为链接文字。 
package.class#member将被自动转换成指向package.class的member文件的URL。

2. @see 的使用

@see 的句法有三种：

@see 类名

@see #方法名或属性名

@see 类名#方法名或属性名

例:

/**  * @see     java.lang.String * @see     #str * @see     #str() * @see     #main(String[]) * @see     java.lang.Object#toString()
 */
public classTestJavaDoc  {   private String str; public void str(){   }public static void main(String[] args){   }}

3、使用 @author、@version 说明类

这两个标记分别用于指明类的作者和版本。缺省情况下 javadoc 将其忽略，但命令行开关 -author 和 -version 可以修改这个功能，使其包含的信息被输出。

这两个标记的句法如下：

@author 作者名

@version 版本号

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

/**  * @author MK* @versionVersion 1.00
 */
public class TestJavaDoc {
}

4. 使用 @param、@return 和 @exception 说明方法

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

@param 参数名 参数说明

@return 返回值说明

@exception 异常类名 说明

每一个 @param 只能描述方法的一个参数，所以，如果方法需要多个参数，就需要多次使用 @param 来描述。

一个方法中只能用一个 @return，如果文档说明中列了多个@return，则 javadoc 编译时会发出警告，且只有第一个 @return 在生成的文档中有效。

方法可能抛出的异常应当用@exception 描述。由于一个方法可能抛出多个异常，所以可以有多个 @exception。每个 @exception 后面应有简述的异常类名，说明中应指出抛出异常的原因。需要注意的是，异常类名应该根据源文件的 import 语句确定是写出类名还是类全名。

示例如下：

public class TestJavaDoc {  /** * @param n a switch * @param b excrescent parameter * @return true or false * @return excrescent return * @exception java.lang.Exception throw when switch is 1* @exception NullPointerException throw when parameter n is null
*/   public boolean fun(Integer n) throws Exception {       switch (n.intValue()) {
          case 0:
             break;
          case 1:
             throw new Exception("Test Only");
          default:
             return false; }      return true; }
}

二、开发软件生成javadoc的方法

（1）netbeans导出javadoc方法：

选择项目名称-->右击-->生成javadoc，即可完成生产文档

（文档一般路径在：工程名下的dist文件夹下的doc文件夹下）

（2）eclipse生成javadoc方法：

选择项目名称-->右击-->Export，选择“java”下的“javadoc”，点击“next”，在javadoc command下的文本框中找到jdk的路径下的javadoc.exe（例如：C:\Program Files\Java\jdk1.7.0_25\bin\javadoc.exe）

点击“next”，在Document title中将文档命名为自己想要的名字（例如：工程名+doc），点击“next”，在“Extra javadoc options(...)”选项中输入“-encoding UTF-8 -charset UTF-8 ”（这个主要是用来解决乱码问题），点击“finish”，即可完成文档的生成

（文档一般路径在：工程名下的doc文件夹下）

（3）javadoc 命令生成javadoc方法

运行： javadoc -help 可以看到 javadoc 的用法，这里列举常用参数如下：

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

1、选项options：

-public 仅显示 public 类和成员

-protected 显示protected/public 类和成员 (缺省)

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

-private 显示所有类和成员

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

-version 包含 @version 段

-author 包含 @author 段

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

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

2、javadoc 编译文档时可以给定包列表，也可以给出源程序文件列表

例如：在 CLASSPATH 下有两个包若干类如下：

mk.Editor

mk.Test

mk.editor.Command

mk.editor.Document

mk.editor.View

1)这里有两个包 (mk 和mk.editor) 和 5 个类。那么编译时 (Windows 环境) 可以使用如下 javadoc 命令：

javadoc    mk\Test.java    mk\Editor.java    mk\editor\Command.java   mk\editor\Document.java    mk\editor\View.java

这是给出 java 源文件作为编译参数的方法，注意命令中指出的是文件路径，应该根据实际情况改变。

2)也可以是给出包名作为编译参数，如：

javadoc   mk   mk.editor

3、详细选项option

-public、-protected、-package、-private 四个选项，只需要任选其一即可。它们指定的显示类成员的程度。它们显示的成员多少是一个包含的关系，如下：

-private (显示所有类和成员)

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

-protected (显示protected/public 类和成员)

-public (仅显示 public 类和成员)

-d 选项允许你定义输出目录。如果不用 -d 定义输出目录，生成的文档文件会放在当前目录下。-d 选项的用法是

-d 目录名

目录名为必填项，也就是说，如果你使用了-d 参数，就一定要为它指定一个目录。这个目录必须已经存在了，如果还不存在，请在运行 javadoc 之前创建该目录。

-version 和 -author 用于控制生成文档时是否生成@version 和 @author 指定的内容。不加这两个参数的情况下，生成的文档中不包含版本和作者信息。

-splitindex 选项将索引分为每个字母对应一个文件。默认情况下，索引文件只有一个，且该文件中包含所有索引内容。当然生成文档内容不多的时候，这样做非常合适，但是，如果文档内容非常多的时候，这个索引文件将包含非常多的内容，显得过于庞大。使用 -splitindex 会把索引文件按各索引项的第一个字母进行分类，每个字母对应一个文件。这样，就减轻了一个索引文件的负担。

-windowtitle 选项为文档指定一个标题，该标题会显示在窗口的标题栏上。如果不指定该标题，而默认的文档标题为“生成的文档（无标题）”。该选项的用法是：

-windowtitle 标题  标题是一串没有包含空格的文本，因为空格符是用于分隔各参数的，所以不能包含空格。同 -d 类似，如果指定了 -windowtitle 选项，则必须指定标题文本。