Android 編程規(guī)范

本編程規(guī)范參考Code Style Guidelines for Contributors整理，如有錯誤，歡迎完善。

一 注釋規(guī)范

1.      類、接口注釋的內(nèi)容

1、用途。開發(fā)人員使用某個類/接口之前，需要知道采用該類/接口的用途

2、開發(fā)維護的日志。一個有關(guān)于該類/接口的維護記錄：時間、作者、摘要。

Eclipse 代碼格式化：

位置：

Window ? Preferences ? Java ? Code Style>Code Template >Code>

New Java files

內(nèi)容：

${filecomment}

${package_declaration}

/**

 * 類說明：  

 * @author  Liucd

 * @date    ${date}

 * @version 1.0

 */

${typecomment}

${type_declaration}

2.     方法注釋的內(nèi)容

1、該方法是做什么的 。

2、傳入什么樣的參數(shù)給這個方法。@param
3、異常處理。@throws
4、這個方法返回什么。@return

二 命名規(guī)范

命名規(guī)范的目的是使程序更易讀。它們也可以提供一些有關(guān)標識符功能的信息，以助于理解代碼，不論它是一個常量、包、還是類。

      應(yīng)該盡量做到以下幾點：使用完整的英文描述來命名；避免命名超長（15 個字符以內(nèi)比較好）；避免相似的命名，例如：persistentObj 和persistentObjs 不要一起使用；anSqlStmt 和anSQLStmt 不要一起使用；慎用縮寫，如果要用到縮寫，則按照縮寫規(guī)則使用縮寫，例如：No.代表number 數(shù)字，ID.代表identification標示。下面分類介紹命名規(guī)范。

1.      包

包名小寫

import com.founder.mobile.common

2.     類/接口

大小寫字母混合組成，頭字母大寫，名字要有意義。

class XmlParseUtils

3.     方法

方法名字是一個動詞，大小寫字母混合組成，第一個單詞的首字母小寫，其后單詞的首字母大寫，名字要有意義。

run();

getBackground();

4.     變量、參數(shù) 

變量用大小寫混合的方式，第一個單詞的首字母小寫，其后單詞的首字母大寫。變量名不應(yīng)以下劃線或美元符號開頭，盡管這在語法上是允許的。

變量名應(yīng)簡短且富于描述。變量名的選用應(yīng)該易于記憶，即，能夠指出其用途。盡量避免單個字符的變量名，除非是一次性的臨時變量。臨時變量通常被取名為i，j，k，m 和n，它們一般用于整型；c，d，e，它們一般用于字符型。

5.     集合、數(shù)組

應(yīng)該從命名中體現(xiàn)其復(fù)數(shù)的含義，例如加后綴s或前綴some，名字要有意義。

customers;
postedMessages;
someCustomers;
someItems ;

6.     域(Field)命名

非公有，非靜態(tài)字段命名以m開頭。 
靜態(tài)域命名以s開頭。
其他字段以小寫字母開頭。
public static final 字段(常量) 全部大寫，并用下劃線連起來。

例子：

7.     文件命名規(guī)范

res/layout目錄下文件：

統(tǒng)一用小寫和下劃線"_"組合命名，建議xml文件加個前綴以便區(qū)分，如對話框的xml配置文件:dlg_name.xml；

res/drawable目錄下文件：

統(tǒng)一用小寫加下劃線“_”組合命名，同上，每個資源文件最好加個前綴以便區(qū)分，如：btn_submit_default.png，btn_ submit _pressed.png，btn_ submit.xml;

三 樣式規(guī)范

1.       注釋/Javadoc ：使用標準樣式寫它

2.      簡短的方法 ：不寫超大的方法，如果一個方法超過一屏，則考慮重構(gòu)。

3.      字段(成員變量)：要么是在該文件的頂部，或緊接在使用它們的方法前面。

4.      局部變量 ：限制作用域

5.      行長度 ：一行的最大長度是一屏。

6.      一致性 ：保證代碼規(guī)范的一致性。

7.      在定義類時，應(yīng)該按照訪問權(quán)限的大小分別排列屬性和方法。

1、public
2、protected
3、包級別(沒有訪問修飾符的，默認為friendly)
4、private

8.     單位使用規(guī)范。

在使用單位時，如果沒有特殊情況，一律采用dip和sp（字體大小單位）這兩個單位。因為這兩個單位是與設(shè)備分辨率無關(guān)的，能夠解決在不同分辨率的設(shè)備上顯示效果不同的問題。

附錄：

Google Code Style Guidelines for Contributors  http://source./source/code-style.html