Java中註釋的進階瞭解

Java中註釋的進階瞭解

記錄JAVA中註釋的一些用法。

---

一般註釋

JAVA中的單行註釋用”//”，如：

String warnStr = "Wrong!" //警告字符串

JAVA中的塊註釋用/* */,如：

/*這
是
一
個
多
行
注
釋*/  
int test = 0;

javadoc實用工具

javadoc會從包，公有類與接口，公有的和受保護的構造器及方法，公有的和受保護的域中提取特性信息，生成html文件。
在這些抽取特性信息的地方應該編寫註釋，註釋以/**開頭，*/結尾。
在註釋中首先用自由文本格式寫上描述性的文字，而後可以用各種標籤來實現特性，此外，在這注釋中支持html標籤，不過不要使用<h1>之類的排版標籤，否則會導致排版錯誤。
可以用的標籤有很多，具體不細表，一般IDE中會自動提供一些，其他的可以自己去了解。
示例如下：

package xyz.zhanymx;
/**
 * <code>People</code>類包含人的姓名,性別與年齡三個屬性,可以作爲一般的職務類的超類.
 * Created by kevin on 16/2/1.
 * @author kevin
 * @version 1.0
 */
public class People {
    private String name;
    private String sex;
    private int age;
    /**
     * 無參構造器,用來對參數初始化.
     */
    public People(){
        name = "";
        sex = "m";
        age = 0;
    }
    /**
     * 一般構造器,構造指定的<code>People</code>對象.
     * @param name 姓名
     * @param sex 性別;性別用m和f表示
     * @param age 年齡
     */
    public People(String name,String sex,int age){
        this();
        this.name = name;
        setSex(sex);
        this.age = age;
    }
    /**
     * 獲取姓名
     * @return 返回String類型的姓名
     */
    public String getName(){
        return name;
    }
    /**
     * 獲取性別
     * @return 返回String類型的性別
     */
    public String getSex(){
        return sex;
    }
    /**
     * 獲取年齡
     * @return 返回int類型的年齡
     */
    public int getAge(){
        return age;
    }
    /**
     * 設置姓名
     * @param name 姓名參數
     */
    public void setName(String name){
        this.name = name;
    }
    /**
     * 設置性別
     * @param sex 對性別的格式進行判斷,如果不符合格式則給出警告
     */
    public void setSex(String sex){
        if ((!sex.equals("m"))&&(!sex.equals("f"))){
            System.out.println("請輸入m或f代表男女");
            return;
        }
        this.sex = sex;
        return;
    }
    /**
     * 設置年齡
     * @param age 年齡參數
     */
    public void setAge(int age){
        this.age = age;
    }
}

生成javadoc文檔形式如下：