【Android注釋技巧】Android函數上面的注釋你是怎麼寫的？（Eclipse中），androideclipse

【Android注釋技巧】Android函數上面的注釋你是怎麼寫的？（Eclipse中），androideclipse

前言：你用過Eclipse快捷鍵 Alt + Shift + J 麼？你看過源碼麼？如果看過，你注意過源碼上面的注釋麼？你知道為什麼看源碼注釋有些標識的參數可以直接點擊跳轉麼？

先出個題目，定義一個最簡單的Person類，三個屬性，一個name，一個age，一個性別，一個帶所有屬性參數的構造函數，你會怎麼寫？

public class Person {     private String mName;     private int mAge;     private int mSex;      public Person(final String name, final int age, final int sex) {         super();         this.mName = name;         this.mAge = age;         this.mSex = sex;     } }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12

我相信沒有人在做項目時是這麼干巴巴地寫吧！一點注釋都沒有！這裡例子簡單，從屬性名就能看出意思，如果換難理解一點的，代碼量又增多時，看起來就會很頭疼了。

1. 如何快速生成文檔注釋

其實Eclipse有快速生成文檔注釋的辦法，光標定位到要注釋的類、屬性或者函數上，然後右鍵 -> Source -> Generate Element Comment，我更喜歡用快捷鍵 Alt + Shift + J，就能自動生成注釋了！

順帶一提一點基礎技巧，圖中右側下面的

• Generate Constructor using 
  Fields… 
  能快速生成帶屬性參數的構造函數；（我上文說要生成多參數構造函數就可以這麼快速生成）
• Generate Getters and Setters… 
  快速生成屬性的獲取器和設置器；（這個功能學校老師為了讓我們多敲點代碼沒說，在實習的時候才知道有這功能）
• Override / Implement Methods… 
  能夠快速選擇要重寫或者要實現的超類的函數；

然後自動生成注釋後的代碼變成了這個樣子

/**  * @ClassName Person  * @Description 人類  * @author AZZ  * @Date 2015年8月6日 下午3:27:39  * @version 1.0.0  */ public class Person {     /**      * @Field @age : 年齡      */     private int mAge;     /**      * @Field @name : 姓名      */     private String mName;     /**      * @Field @sex : 性別      */     private int mSex;     /**      * @Description 構造函數      * @param age 年齡      * @param name 姓名      * @param sex 性別      */     public Person(int age, String name, int sex) {         super();         this.mAge = age;         this.mName = name;         this.mSex = sex;     } }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33

雖然代碼變長了，但是注釋清晰，容易閱讀了，最關鍵的是，文檔注釋能讓你在其他用到該類、該方法、該屬性的地方有提示。 
你的代碼添加注釋後也這個樣子麼？我想應該是不一樣的。因為我修改了注釋模板！~所以你看到會有一些自定義的標簽比如“@ClassName”，“@Description”,“Field”。如果喜歡這個模板可以去看第三點怎麼改。

2. 文檔注釋中字段的含義（重點）

由於後面圖片過大，導致看起來不是很簡潔，所以先總結一下，有不明白的下面都有截圖說明。

（空）在所有標簽上面寫的文字將成為描述該函數的關鍵性文字
@author 作者信息
@param 參數信息
@return 返回信息
@exception 異常信息
@throws 拋出異常信息 （@exception 和 @throws 經測試效果是一樣的）
@category 分類信息
@since 自哪個版本開始
@see 有的函數需要借助其他類或者函數或者屬性，就用該標簽標識。 


@see #本類函數名/屬性名 可以查看其他函數或屬性
@see 包名.類名 可以查看其他類 
-




@deprecated 表示該函數不建議使用了，在這個標簽裡寫上為什麼不建議使用以及提供替換該方法的新方法。加上這個標簽後，注釋顯示裡不會提示，但是函數名會被畫一道刪除線 
-
引用到別的參數或者類或者函數。可以這麼做：用{@link #函數名/屬性名}來鏈接本類屬性/函數，用{@link 包名.類名}來鏈接其他類 
-
2015.8.14更新：當希望注釋換行時，可以在新一行注釋前加上<p>（如果不加，就算換行了，鼠標放在函數上顯示的也是沒有換行，類似html）

下面正式附圖說明：

在文檔注釋中用一些字段標明信息，能很明確的告訴別人這個函數/類的作用，而且文檔注釋很棒的一點就是在別的地方調用時把鼠標放在該函數/類上時，能夠看到你之前寫好的注釋。

在文檔注釋代碼段中，默認帶有的字段有

• （空）在所有標簽上面寫的文字將成為描述該函數的關鍵性文字
• @author 作者信息
• @param 參數信息
• @return 返回信息
• @exception 異常信息
• @throws 拋出異常信息 （@exception 和 @throws 經測試效果是一樣的）
• @category 分類信息
• @since 自哪個版本開始

測試代碼段

 /**      * 測試方法-測試各個注釋標簽的顯示      * @author 作者信息 - AZZ      * @param param 輸入參數      * @return 返回參數      * @throws Exception 參數不合法異常      * @exception IllegalArgumentException param小於0 或者 param大於100      * @category 分類信息      * @since JDK1.0      */     public boolean test(int param) throws Exception {         if (param < 0 || param > 100) {             throw new Exception("wrong param");         }         return false;     }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16

把鼠標放在test上會顯示如下

• @see 有的函數需要借助其他類或者函數或者屬性，就用該標簽標識。 
  
  • @see #本類函數名/屬性名 可以查看其他函數或屬性
  • @see 包名.類名 可以查看其他類 
    
    
    點擊可以跳轉顯示相應類/函數/屬性注釋 
    
    
• @deprecated 表示該函數不建議使用了，在這個標簽裡寫上為什麼不建議使用以及提供替換該方法的新方法。加上這個標簽後，注釋顯示裡不會提示，但是函數名會被畫一道刪除線

• @自定義標簽名 比如@Date @Description等，可以自己自定義一些標簽名，這些標簽的注釋會自動排列到默認標簽的下面

• 另外，在文檔注釋裡面，比如@param 的解釋中，有時候我們需要引用到別的參數或者類或者函數。比如，現在在Person類裡面定義兩個整型常量，標識男女，在setSex()函數中，我想提示使用者設置我已經給定的兩個常量，可以這麼做：用{@link #函數名/屬性名}來鏈接本類屬性/函數，用{@link 包名.類名}來鏈接其他類（是不是想到了@see?）

    /**      * @Field @MALE : 男性      */     public static int MALE = 0;     /**      * @Field @FEMALE : 女性      */     public static int FEMALE = 1;      /**      * the mSex to set      * @param sex  either {@link #FEMALE} or {@link #MALE}       * 測試鏈接方法 {@link #test(int)}      * 測試鏈接類 {@link com.test.note.Person}      */     public void setSex(int sex) {         this.mSex = sex;     }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18

把鼠標放在函數名上 

點擊可以跳轉注釋

• 2015.8.14更新 
  當希望注釋換行時，可以在新一行注釋前加上<p>（如果不加，就算換行了，鼠標放在函數上顯示的也是沒有換行，類似html）如圖 
  
  加上<p>標簽後 
  

3. 如何修改注釋模板

不繞圈子，直接給出我在用的模板。下載地址 
想了解更多地搜索關鍵字“Eclipse 注釋模板”，可以自己自定義模板。

使用方法：打開Eclipse -> Window -> Preferences -> Java -> Code Style 
1.點擊Code Templates -> Import … “MyCodetemplates.xml” 
2.點擊Formatter -> Import …”MyFormatter.xml”

問啊-定制化IT教育平台，牛人一對一服務，有問必答，開發編程社交頭條 官方網站：www.wenaaa.com

QQ群290551701 聚集很多互聯網精英，技術總監，架構師，項目經理！開源技術研究，歡迎業內人士，大牛及新手有志於從事IT行業人員進入！