註解 Comments

對於每一個開發者而言，為程式碼加入註解是一種極好的習慣。雖然它表面上看起來會對開發進度有一定的影響，但這本身亦應當屬於開發過程的一部分。這並不意味著我們要對項目中存在的屬性、函数、類、結構或其它每一樣東西事無巨細地編到文檔中去，這根本是不可能的事情。而是應該「合理」說明解釋，也就是：

• 描述類、方法和屬性的用途，粗略程度要適當。而且最好對調用方法時應當注意的前提條件、事項或限制做重點說明。
• 高亮標出方法的輸入/輸出（參數及返回值）。
• 當你事隔幾個月再次閱讀項目程式碼時，程式碼中每一個方法的用途和每一個屬性的意義你都能輕鬆憶起。
• 當你分享程式碼或庫時，別的開發者能夠很容易就明白這些程式碼要如何使用。
• 當使用正確的註解時，才能產生好的JavaDoc文件。

一.類別Class註釋:

/**
* 父類別
* @author 作者
*/
public class AppActivity extends BaseActivity {}

二.方法註釋:

/**
*取得名稱
*@param key 鍵值
*@param mObject 對象
*@return 返回值
*/
public String getName(String key,Object object){}

三.一般常數變數註釋:

// intent跳轉指定值
public static final int INTENT_APP=1001;