文档注释笔记
Java语言中强大的注释形式：文档注释。如果编写Java源代码时添加了合适的文档注释，然后通过Jdk提供的javadoc工具可以直接将源代码中的文档注释提取成一份系统的API文档。
1.问题：API文档是什么？
开发一个大型软件时，需要定义成千上万的类，而且需要很多人参与开发。每个人都会开发一些类，并在类里定义了一些方法、属性提供给其他人使用，但其他人怎么知道如何使用这些类和方法呢？
这时候需要提供一份说明文档，用于说明每个类、每个方法的用途。当其他人使用一个类或一个方法的时候，他无需关心这个类或者方法的具体实现，他只要知道这个类或方法的功能即可，然后使用这个类或者方法来实现具体目的，也就是通过调用应用程序接口（API）来编程。API文档就是用以说明这些应用程序接口的文档。对于Java语言而言，API通常详细说明了每个类、每个方法的功能、用法等。
2.文档注释、API文档、Javadoc工具
文档注释用于生成API文档，API文档主要用于说明类、方法和属性的功能。javadoc只处理源文件在类、接口、方法、属性、构造器和内部类之前的注释，忽略其他地方的注释。javadoc工具默认处理以public和protected修饰的类、接口、方法、属性、构造器之前的文档注释。如果要提取private修饰的内容，可以在使用javadoc工具时增加-private选项。
3.文档注释语法：
文档注释以斜线后跟两个星号（\**），以星号后跟一个斜线（*/）作为结尾，中间部分全是文档注释，会被提取到API文档中去。
4.范例
package wang; /** * Description: * <br/>Copyright(C), 2011-08-04， 汪斌伟 * <br/>这段代码为测试用途 * <br/>ProgrameName: * <br/>Date: * @author:汪斌伟 * @version 1.0 */ public class TestJavadoc { /** *简单测试属性 */ protected String name; /** *主方法，程序的入口 */ public static void main(String[] args) { System.out.println("测试Javadoc代码"); } }