本文章主要包括以下6個內容：

一、註釋分類以及javadoc的使用

二、使用Alibaba Java CodingGuidelines規範編碼。

三、IDEA配置類註釋

四、IDEA配置方法註釋

========================================正文開始========================================

一、註釋分類以及javadoc的使用。

所謂註釋就是隻給人看的，而並不會被執行的語句。適當的程式碼註釋可以提高程式碼可讀性，也方便後期的維護，所以在程式設計初期就要養成良好的編碼習慣。程式碼註釋分為一下三種：

1、單行註釋： // ……單行註釋。

2、多行註釋： /* ...... */ 多行註釋，註釋內容不會出現在javadoc 生成的文件中。

3、文件註釋 : /** ...... */ 多行註釋，註釋內容寫入javadoc生成的文件。

這三種註釋的具體使用可使用Alibaba Java CodingGuidelines外掛進行學習。詳見第二大點。

3.1javadoc生產API文件

可參見官方文件：https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html

這裡對Two.java檔案進行生產API文件

Two.java檔案的檔案內容為：

/**
 
 * @author ThreePure
 * @date 20/9/16 8:52
 * @description:輸出Hello World
 * @since 1.8
 */
public class Two {
    public static void main(String[] args) {
        System.out.println("Hello World");
    }
}

在java檔案中執行cmd命令列視窗，執行：javadoc -encoding UTF-8 -charset UTF-8 Two.java

生成後文件內容為

這裡開啟index.html檔案就可以開啟生產的API文件。這裡舉例原始碼中的@since 1.8，以及類名等在API文件中就有所體現。

二、使用Alibaba Java CodingGuidelines規範編碼。

2.1瞭解什麼是Alibaba Java CodingGuidelines？

Alibaba Java CodingGuidelines是阿里巴巴於2017年10月14日在杭州雲棲大會上，正式釋出眾所期待的《阿里巴巴Java開發規約》掃描外掛！該外掛由阿里巴巴P3C專案組研發。P3C是世界知名的反潛機，專門對付水下潛水艇，寓意是掃描出所有潛在的程式碼隱患。這個專案組是阿里巴巴開發愛好者自發組織形成的虛擬專案組，把《阿里巴巴Java開發規約》強制條目轉化成自動化外掛，並實現部分的自動程式設計。

簡單的說就是一個程式設計時的規則，是程式碼更加的美觀可讀。特別是對呀一些程式設計小白，能夠從一開始就養成良好的程式設計習慣。

阿里巴巴基於手冊內容，研發了一套自動化的IDE檢測外掛（IDEA、Eclipse）。該外掛在掃描程式碼後，將不符合規約的程式碼按Blocker/Critical/Major三個等級顯示在下方。甚至在IDEA上，還基於Inspection機制提供了實時檢測功能，編寫程式碼的同時也能快速發現問題所在。對於歷史程式碼，部分規則實現了批量一鍵修復的功能。極大的提高了程式碼質量。

2.2 在IDEA中安裝Alibaba Java CodingGuidelinesPlugins 。

安裝完成後有多種方式使用。

點選編碼規約掃描，掃描結果可能出現如圖：

根據bug的嚴重程度，優先順序定義了Blocker,Critical,Major，Minor/Trivial幾個等級。單擊即可檢視相應的規則和建議。

歸於新手而言最好的功能還是它能實時地檢查你書寫的程式碼，並且在右側實時給出警告，而且警告也是漢字。在你書寫的程式碼中只要存在不符合規範的地方就會用黃色的波浪線顯示出來，當滑鼠放上去，就會顯示相應的提示資訊。這就能夠形成一個很好的編碼規範和程式設計習慣。

阿里規範程式碼已經開源，GitHub：https://github.com/alibaba/p3c

三、IDEA配置類註釋

我的內容是：（可以直接複製貼上使用）

/**
 * @author username
 * @date ${DATE} ${TIME}
 * @since 1.8
 * @description:TODO
 */

設定完成後在以後每次新建類時都會自動產生該註釋。

四、IDEA配置方法註釋

方法註釋的設定跟類註釋基本一致。開啟Settings=》Editor=》Live Templates。選擇右側的+號，選擇Templates Group。

彈出一下視窗，輸入想要的組名即可：

2，選擇剛剛建好的組，點選右側+號，點選Live Template

建立一個新的模板：

Abbreviation：是縮寫的意思，也就是在需要產生這個註釋的地方輸入這個內容，摁下回車（也可以設定其他的），就可以產生註釋。建議越短越好。

Description：新增一個描述資訊，只是為了方便知道這個縮寫用來幹嘛，是可選的。

Template text：輸入模板。這裡特別注意當輸入一個變數時，比如圖中的date，time，param以及return，這些是變化的，注意這裡不需要{}。當這裡有變化的量時，右邊的Edit variables才可以選擇新增。

我這裡設定模板內容為：（可直接貼上使用）

/**
 * @author ThreePure
 * @date $date$ $time$
 * @description:
 * @Param:$param$
 * @Return:$return$
 */

這裡解釋一下param和return兩個變數，param是指引數，也就是這個方法會有哪些引數，return是指返回型別。但是需要自動產生這兩個值，就必須在方法內部使用。如果在方法外部使用，將無法獲得這兩個引數。Expression具體設定參照上圖。