Java文档注释

1.Java注释

Java有三种注释方式。
①//行注释
②/*......*/注释若干行
③/**......*/注释若干行，并可生成Java文档
通常它的写法是这样的
/**
*......
*......
*/

2.Java文档注释的格式化

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

3.Java文档注释的三部分

/** 
* play方法的概要. 
* <p>play方法的详细说明第一行<br> 
* play方法的详细说明第二行<br>
* play方法的详细说明第三行<br>
* @param i 参数说明 
* @return 没有返回值 
*/ 
public void play(int i) { 

} 

第一部分概要。文档中，对于属性和方法都是先有一个概要，然后才在后面一个一个的详细的说明。概要部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是概要，之后是第二部分和第三部分。 
第二部分是详细说明。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。概要也在里面。
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。 
第二部分和第三部分可以统称为详细资料。

4.常用javadoc标记

@author      作者标识。
@version     版本号。
@see         查看相关内容，如类、方法、变量等。
@param       方法的入参名及描述信息，如入参有特别要求，可在此说明。
@return      对方法返回值的说明 。
@throws     构造函数或方法所会抛出的异常
@since       API在什么程序的什么版本后开发支持
@exception   对方法可能抛出的异常进行说明，同@throws。 
{@link包.类#成员 标签} 链接到某个特定的成员对应的文档中。
{@value} 当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。
其中，@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号(,)隔开。@version 也可以使用多次，只有第一次有效。

5.javadoc命令

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

选项： 
-public 仅显示 public 类和成员 
-protected 显示 protected/public 类和成员 (缺省) 
-package 显示 package/protected/public 类和成员 
-private 显示所有类和成员 
-d <directory> 输出文件的目标目录 
-version 包含 @version 段 
-author 包含 @author 段 
-splitindex 将索引分为每个字母对应一个文件 
-windowtitle <text> 文档的浏览器窗口标题 

6.应用举例

class Javadoc{
	/** 
    * play方法的概要.
    * <p>play方法的详细说明第一行<br> 
    * play方法的详细说明第二行<br>
    * play方法的详细说明第三行<br>
    * @param i 参数说明 
    * @return 没有返回值 
    */ 
	public void play(int i){	
	}

	public static void main(String[] args) {
	}	
}

生成的Java文档部分截图：