thinking in java test練習(12)(13)javadoc的生成

練習(11)找出HelloDate.java的第二個版本,也就是那個簡單註釋文檔的示例。對該文件執行javadoc,然後通過web瀏覽器觀看運行結果。

HelloDate.java的第二個版本就是P35面有註釋那個版本
代碼:

import java.util.Date;

/**
 * Created by lenovo on 2016/7/30.
 * The first Thinking in java example program.
 * Displays a string and today's date.
 * @author nikerxu
 * @version 1.0
 */
public class test2_11 {
    /**
     * Entry point to class & application.
     * @param args array of string arguments.
     * @throws exceptions No exception thrown
     */
    public static void main(String[] args){
        System.out.println("Hello,it's: ");
        System.out.println(new Date());
    }
}

生成javadoc的方法,在eclipse裏找project,itellij裏找tools這兩個菜單目錄下會有一個generate javadoc的選項,點擊即可生成javadoc
生成的文件目錄如下這裏寫圖片描述
在thinking in Java裏面(這個是工程名,找你項目所在的工程名即可),找到test2_11也就是類名,打開就是
這裏寫圖片描述
練習(13)與(12)做法相同,不再重複。
這裏簡單介紹一下注釋的幾種類型。
首先註釋方式有三種:
一種是先打/**,然後按enter鍵就會出現這樣的:
/**
* 註釋內容
*/
另一種與上一種方式類似,先打/*,按enter鍵後:
/*
註釋內容
*/
這兩種有什麼區別呢?如果你使用編譯器就會發現,第一種與第二種顏色是不一樣的,在第一種註釋裏打@,會出來類似代碼提示的提示信息,而第二種,則沒有。不過兩種註釋方式註釋的內容都會忽略,所以大同小異,只不過第一種方便一點。
還有一種方式是按Ctrl+/ ,會出現//並將光標所在的行註釋掉,這種方法稱爲單行註釋,是最方便的。
基本的一些標籤:
@author 用於對類的說明 標明開發該類模塊的作者
@version 用於對類的說明 標明該類模塊的版本
@see 用於對類、屬性、方法的說明 參考轉向,也就是相關主題
@param 用於對方法的說明 對方法中某參數的說明
@return 用於對方法的說明 對方法返回值的說明
@exception 用於對方法的說明 對方法可能拋出的異常進行說明
更具體內容請看書本或Java官方文檔的介紹。
以上

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章