Android中的註釋以及修改註釋模板的方法

1、常見的註釋方法

@author 

作者信息

@link

在註釋中使用，可以快速定位一個類、子類、類中的方法或者類中的字段，Ctrl+左鍵，就可以快速跳轉到鏈接的類或方法

/**
 * 這裏要引用一個類 {@link package.MyClass} <br/>
 * 這裏要引用一個類裏面的子類 {@link package.MyClass.SubClass}<br/>
 * 這裏要引用一個類裏面的方法 {@link package.MyClass#method(Context, Object)} // 注意這裏()裏面的是方法的參數類型，使用不同的參數簽名可以來區別不同的重載方法 <br/>
 * 這裏要引用一個類裏面的字段 {@link package.MyClass#field} // 這裏不區分字段是否是public 或者 static，都可以直接引用 <br/>
 */

@linkplain

同link，但是這裏可以給類起一個別名

/**
 * 這裏要引用一個類 {@linkplain package.MyClass 別名} <br/>
 */

@param

方法參數說明

/**
 * @param param1 這裏是參數1的說明
 * @param param2 這是是參數2的說明
 */
void method(int 參數1, int 參數2) { }

@see

一般在註釋尾部，用於添加一些可以參考的地方，比如該方法可以參考其他的相關的什麼方法

/**
     *
     * @param 參數1 這裏是參數1的說明
     * @param 參數2 這是是參數2的說明
     *            
     * @see #method()
     * @see #method(int)
     */
    void method(int 參數1, int 參數2) {

    }

    void method() {
    }

    void method(int 參數1) {
    }

@deprecated

標記方法已廢棄，可以用@link標記新的替換方法

@exception

用於說明方法會拋出什麼樣的異常，什麼情況下回拋出異常

@return 

返回信息

@throws 

拋出異常信息 （@exception 和 @throws 經測試效果是一樣的）

@category

 分類信息

@since

 自哪個版本開始

 

2、自定義註釋模板

步驟：

基本的需求，可以根據自己的需求隨意修改

/**
 * @Name：${PROJECT_NAME}
 * @Description：描述信息
 * @Author：${USER}   
 * @Date：${DATE} ${TIME} 
 * 修改人：${USER}  
 * 修改時間：${DATE} ${TIME}  
 * 修改備註：  
 * @version
 */