小注釋，大學問

遇到過很多JAVA或者其他編程初學者有一個小煩惱，那就是：我能不能給我寫的這麼多代碼都弄一個標註、解釋說明啥的，方便我後面快速看出這裏的功能或者一些需要說明的東西。那麼接下來就來教你如何在代碼中添加註釋以及快捷鍵添加註釋！

註釋的內容是完全不會被編譯器編譯的，也就是說對於代碼而言，那就是空氣，無論你在註釋裏怎麼寫代碼或者其他的，和運行以後的結果沒有半毛錢關係！

首先JAVA中註釋分爲三種：

單行註釋、多行註釋、以及文檔註釋。如下：

    //單行註釋  快捷鍵（Windows）：Ctrl + /

    /*
     * 多行
     * 註釋    快捷鍵（Windows）：Ctrl + Shift + /
     * */

    /**
     * 文檔
     * 註釋
     * */

關於三種註釋的選擇：

一般情況下建議使用單行註釋，這樣可以讓代碼看上去更加整潔，並且不容易造成代碼的混亂。比如這樣：

public static void main(String[] args) {
        //輸出Hello World!
        System.out.println("Hello World！");
    }

而多行註釋則適用於說明文字是一大段的代碼：

public static void main(String[] args) {
        /*
        * 利用System.out.println()輸出（換行）
        * 輸出內容是：Hell World！
        * System.out.print()則是輸出完不換行
        * */
        System.out.println("Hello World！");
    }

文檔註釋的話多用於實際軟件開發，像@param x這樣的標記是用來說明參數類型、返回值、方法說明等，初學者一般重點掌握單行註釋和多行註釋即可。如下是.println的源碼以及註釋：

     /**
     * Prints a String and then terminate the line.  This method behaves as
     * though it invokes <code>{@link #print(String)}</code> and then
     * <code>{@link #println()}</code>.
     *
     * @param x  The <code>String</code> to be printed.
     */
    public void println(String x) {
        synchronized (this) {
            print(x);
            newLine();
        }
    }

小拓展（TODO）

TODO 加在你的註釋符號的後面（多行是在 /* 後面），就可以實現一個“標記”的效果，你可以通過底部工具欄TODO來快速定位你做過標記的位置，用起來還是非常方便的！

public static void main(String[] args) {
        //TODO 這裏需要加上輸出的內容
        /*TODO
        * 這裏需要加上輸出的內容
        * */
        System.out.println("");
    }

感謝閱讀！有問題歡迎評論或者私聊喲！點個關注？點個贊？