JAVA系列讲座5（基础篇之JAVA注释文档）

　　可为一系列作者使用多个这样的标记，但它们必须连续放置。全部作者信息会一起存入最终HTML代码的单独一个段落里。

　　变量文档标记

　　变量文档只能包括嵌入的HTML以及@see引用。

　　方法文档标记

　　除嵌入HTML和@see引用之外，方法还允许使用针对参数、返回值以及违例的文档标记。

　　1. @param

　　格式如下：

　　@param 参数名 说明

　　其中，“参数名”是指参数列表内的标识符，而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记，就认为前一个说明结束。可使用任意数量的说明，每个参数一个。

　　2. @return

　　格式如下：

　　@return 说明

　　其中，“说明”是指返回值的含义。它可延续到后面的行内。

　　3. @exception

　　简言之，它们是一些特殊的对象，若某个方法失败，就可将它们“扔出”对象。调用一个方法时，尽管只有一个违例对象出现，但一些特殊的方法也许能产生任意数量的、不同类型的违例。所有这些违例都需要说明。所以，违例标记的格式如下：

　　@exception 完整类名 说明

　　其中，“完整类名”明确指定了一个违例类的名字，它是在其他某个地方定义好的。而“说明”（同样可以延续到下面的行）告诉我们为什么这种特殊类型的违例会在方法调用中出现。

　　4. @deprecated

　　这是Java 1.1的新特性。该标记用于指出一些旧功能已由改进过的新功能取代。该标记的作用是建议用户不必再使用一种特定的功能，因为未来改版时可能摒弃这一功能。若将一个方法标记为@deprecated，则使用该方法时会收到编译器的警告。

　　文档示例

　　下面是一段带有注释的Java程序：

//: HelloDate.java
import java.util.*;
/** The first Thinking in Java example program.
 * Displays a string and today‘s date.
 * @author Bruce Eckel
 * @author www.BruceEckel.com
 * @version 2.0 
*/
public class HelloDate {
  /** Sole entry point to class & application
   * @param args array of string arguments
   * @return No return value
   * @exception exceptions No exceptions thrown
  */
  public static void main(String[] args) {
    System.out.println("Hello, it‘s: ");
    System.out.println(new Date());
  }
} ///:~

　　第一行：“//: HelloDate.java”采用了自定义的方法：将一个“:”作为特殊的记号，指出这是包含了源文件名字的一个注释行。最后一行也用这样的一条注释结尾，它标志着源代码清单的结束。这样一来，可将代码从正文中方便地提取出来，并用一个编译器检查。

　　注：本节大部分内容出自Bruce Eckel的《Thinking in JAVA》。

　　 (to be continue)

　　下节将进入下一章，JAVA多线程编程