本文章主要包括以下6個內容：
一、注釋分類以及javadoc的使用
二、使用Alibaba Java Coding Guidelines規范編碼。
三、IDEA配置類注釋
四、IDEA配置方法注釋
====================正文開始====================
一、注釋分類以及javadoc的使用。
所謂注釋就是只給人看的，而並不會被執行的語句。適當的代碼注釋可以提高代碼可讀性，也方便后期的維護，所以在編程初期就要養成良好的編碼習慣。代碼注釋分為一下三種：
1、單行注釋： // ……單行注釋。
2、多行注釋： /* ...... */ 多行注釋，注釋內容不會出現在javadoc 生成的文檔中。
3、文檔注釋 : /** ...... */ 多行注釋，注釋內容寫入javadoc生成的文檔。
這三種注釋的具體使用可使用Alibaba Java Coding Guidelines插件進行學習。詳見第二大點。
3.1javadoc生產API文檔
可參見官方文檔：https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html
這里對Two.java文件進行生產API文檔
Two.java文件的文件內容為：
1 /** 2 * @author ThreePure 3 * @date 20/9/16 8:52 4 * @description:輸出Hello World 5 * @since 1.8 6 */ 7 public class Two { 8 public static void main(String[] args) { 9 System.out.println("Hello World"); 10 } 11 }
在java文件中運行cmd命令行窗口，執行：javadoc -encoding UTF-8 -charset UTF-8 Two.java
生成后文件內容為
這里打開index.html文件就可以查看產生的API文檔。
二、使用Alibaba Java Coding Guidelines規范編碼。
2.1了解什么是Alibaba Java Coding Guidelines？
Alibaba Java Coding Guidelines是阿里巴巴於2017年10月14日在杭州雲棲大會上，正式發布眾所期待的《阿里巴巴Java開發規約》掃描插件！該插件由阿里巴巴P3C項目組研發。P3C是世界知名的反潛機，專門對付水下潛水艇，寓意是掃描出所有潛在的代碼隱患。這個項目組是阿里巴巴開發愛好者自發組織形成的虛擬項目組，把《阿里巴巴Java開發規約》強制條目轉化成自動化插件，並實現部分的自動編程。
簡單的說就是一個編程時的規則，使代碼更加的美觀可讀。特別是對呀一些編程小白，能夠從一開始就養成良好的編程習慣。
阿里巴巴基於手冊內容，研發了一套自動化的IDE檢測插件（IDEA、Eclipse）。該插件在掃描代碼后，將不符合規約的代碼按Blocker/Critical/Major三個等級顯示在下方。甚至在IDEA上，還基於Inspection機制提供了實時檢測功能，編寫代碼的同時也能快速發現問題所在。對於歷史代碼，部分規則實現了批量一鍵修復的功能。極大的提高了代碼質量。
2.2 在IDEA中安裝Alibaba Java Coding Guidelines Plugins 。
安裝完成后有多種方式使用。
點擊編碼規約掃描，掃描結果可能出現類似下圖的結果：
根據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：是縮寫的意思，也就是在需要產生這個注釋的地方輸入這個內容，摁下回車（也可以根據By default expand with屬性選擇其他鍵），就可以產生注釋。建議越短越好。
Description：添加一個描述信息，只是為了方便知道這個縮寫用來干嘛的。
T emplate text：輸入模板。這里特別注意當輸入一個變量時，比如圖中的date，time，param以及return，這些是變化的，當IDEA識別到輸入了變量時，需要在右邊的Edit variables中添加函數才能有效。注意這里需要區別設置類方法時的{DATE}，這里不需要{}。
我這里設置模板內容為：
/** * @author username * @date $date$ $time$ * @description: * @Param:$param$ * @Return:$return$ */
Expression具體設置參照下圖
這里解釋一下param和return兩個變量，param是指參數，也就是這個方法會有哪些參數，return是指返回類型。但是需要自動產生這兩個值，就必須在方法內部使用。如果在方法外部使用，將無法獲得這兩個參數。
