java基礎之 java註釋

JAVA裏有2中註釋風格。

一種以 「/*」 開始以 「*/」 結尾，另外一種是以 「//」 起頭的。

被註釋的內容不會被java虛擬機編譯，因此這就是爲何用反編譯編譯源代碼沒有註釋的緣由。

舉個栗子

package test;

public class JavaDoc {
    /*這是單行註釋*/

    /**
     * 這是多行註釋
     * 能夠寫不少行
     */
    
    //這是單行註釋，按2次斜槓就能夠了

    //這種註釋能夠只有開頭
    //全部也能夠寫不少行
    
    public static void main(String[] args) {

    }
}

反編譯JavaDoc.class後的內容

package test;

public class JavaDoc {
    public JavaDoc() {
    }

    public static void main(String[] args) {
    }
}

擴展

若是你使用 lntelliJ IDEA 進行編碼的話，你還可使用 「//region //endregion「來自已註釋代碼塊，方便閱讀源代碼哦。能夠選中要註釋的代碼塊，而後快捷鍵 Ctrl+Alt+T ，選擇region 便可。

//region 這是把其中的代碼摺疊起來
public static void main(String[] args) {

}
//endregion

摺疊後

這是把其中的代碼摺疊起來

java文檔註釋

java文檔註釋是爲了輸出代碼註釋文檔，讓代碼和文檔分離，便於查看文檔。好比java API 文檔，就是java底層開發者的文檔註釋，每次修改後只要輸入文檔便可，不用花費時間人力去維護開發的api。

在java文檔註釋javadoc中可以使用嵌入html和「文檔標籤」，經過javadoc輸入的註釋文檔是一個html文檔，因此咱們能夠在文檔註釋使用html標籤。

若是你想在嵌入的html代碼中寫行內樣式，這是能夠滴，爲何？由於我試過了。你能夠本身美化你的註釋哦，可是這回讓你的源註釋包含太多樣式，不利於閱讀，最好仍是不要這樣搞。

在文檔註釋中使用嵌入html代碼和寫html頁面同樣，你們可自行學習html便可。

在文檔「文檔標籤」的話，須要使用指定的標籤和寫法，全部的文檔標籤都是用@ 符號聲明，後面記得加空格。

1. @see 引用其類，@see class-name 轉化爲html標籤的 a 標籤，連接到其餘文檔。
2. @author 聲明做者。
3. @throws 聲明方法可能會跑出的異常，調用者要進行處理。
4. @param 參數說明，@param name desc。以上可文檔標籤均可寫多個，但多個必須是連續的。
5. @return 表示返回值。

舉個栗子

package test;
public class JavaDoc {
    /**
     * <p>方法描述：變量自動加一.</p>
     * <p>建立時間：2019-03-31 23:40:54</p>
     * <p>建立做者：李興武</p>
     *
     * @param i 進行自動加一的數
     * @return 返回加一後的結果
     * @throws RuntimeException 被操做數爲0，會拋出異常
     * @author "lixingwu"
     * @see IfElse
     */
    public Integer add(int i) throws RuntimeException {
        if (i == 0) {
            throw new RuntimeException("被操做數不能爲0");
        }
        i++;
        return i;
    }
}

輸出的JavaDoc.html

擴展

若是您使用的lntelliJ IDEA 進行編碼的話，可使用 Tools -> Generate JavaDoc 來生成文檔。

註釋規約

根據阿里巴巴java開發手冊說明：

1. 【強制】類、類屬性、類方法的註釋必須是用 /**內容*/ 格式，不得使用//xxx方式;
2. 【強制】全部的抽象類必須有javadoc註釋，詳細說明其做用；
3. 【強制】全部的javadoc必須有 添加時間 和 建立做者 ；
4. 【強制】方法內的單行註釋，必須另起一行，使用 // 註釋，多行註釋使用 /**/；
5. 【強制】全部的枚舉類型必須有註釋，說明每項數據的做用；