Java复习笔记（三）——文档注释

   java提供了一种功能强大的注释形式：文档注释。如果编写Java源代码时添加了合适的文档注释，然后通过JDK提供的javadoc工具可以直接将源代码里的文档注释提取成一份系统的API文档。

   1.javadoc简介

   javadoc采用了部分来自Java编译器的技术，查找我们置入程序的特殊注释标记。它不仅提取由这些标记指示的信息，也将毗邻注释的类名或方法名提取出来。这样一来，我们就可用最轻的工作量，生成十分专业的程序文档。 

   javadoc输出的是一个HTML文件，可用自己的Web浏览器查看。该工具允许我们创建和管理单个源文件，并生动生成有用的文档。由于有了jvadoc，所以我们能够用标准的方法创建文档。而且由于它非常方便，所以我们能轻松获得所有Java库的文档。

  2.javadoc语法

  文档注释以“/**”开始，结束于一个“*/”。

如下面这个简单的例子所示：

/** 一个类注释 */ 
public class docTest { 
/** 一个变量注释 */ 
public int i; 
/** 一个方法注释 */ 
public void f() {} 
}

     javadoc只能为public（公共）和protected（受保护）成员处理注释文档。“private”（私有）成员的注释会被忽略，我们看不到任何输出（也可以使用javadoc命令时用-private标记包括private成员）。这样做是有道理的，因为只有public和 protected成员才可在文件之外使用，这是客户程序员的希望。然而，所有类注释都会包含到输出结果里。 

  3.javadoc常用标记