注释文档

对于代码文档的维护是编程工作中的一个重要的部分，这往往也是最繁杂而费时的工作，Java的注释文档可以直接将代码和文档链接起来，这样可以十分方便的对注释进行管理。

一、语法
所有的javadoc命令都只能在”/* * */“之间出现，其主要方式有两种：一种是直接嵌入HTML，而另一种是使用文档标签。注释文档又可以分为三种，分别是类注释、域注释和方法注释；
一个简单的例子：

/** A class comment */
public class Document {
    /** A field comment */
    int a;
    /** A function comment */
    public void fun() {}
    public static void main(String[] args) {}
}

二、一些常用的文档注释标签
1、@author
2、@param
3、@version
4、@return

/**
* this is ricken’s ID card class with documentation
*
* @author ricken
* @version 4.1
*
*/
public class Person {

    /** id number of person */
    public String idNumber;

    /** real name of person */
    public final String realName = “wang kang”;
    int age;

    /**
    * @param realName real name
    * @param id id number
    * @return age of person
    */
    public int getAge(String realName, String id) {
         return age;
    }
}