Android專案及編碼的規範

在開發中，遵循良好的編碼規範，不僅僅可以提高**的可讀性，減小出錯的可能性，同時也降低與其他開發者交流的成本，易於他人的維護與協作。本文簡單總結了android開發中的一些**規範，供開發者參考。

① 除了注釋，**中不出現中文

② 每個類寫上必要的注釋，類的說明，作者，****

③ 方法加上必要的注釋說明，方便以後維護

（1）base:存放基礎類的包，裡面的類以base為字首，例如baseactivity；

（2）activity:存放activity的包，每個activity命名以activity結尾，例如mainactivity;

（3）fragment:存放fragment的包，每個fragment命名以fragment結尾，例如chatfragment;

（4）receiver:存放receiver的包；

（5）service:存放service的包；

（6）adapter:存放adapter的包，每個adapter命名以adapter結尾，例如eventitemadapter;

（7）common:存放一些公共常量，例如後端介面、sharedpreferencekey、intentextra等;

（8）utils:存放工具類的包，比如常見的工具類：logutils、dateutils；

（9）entity:存放實體類的包；

（10）widget:存放自定義view的包；

以上是一些常見的包，但不侷限於此，視專案的具體情況而定。

類的命名

命名應該遵循駝峰命名法

對於繼承自android元件的類來說，命名是應以改組件的名稱結尾；列如：singinactivity, singinfragment , imageuploaderservice,changepassworddialog .

res中檔案的命名

資源檔案應該以小寫+下劃線（_）的格式命名。

檔案

以下是對於檔案的命名習慣

對於圖示的命名習慣

對於選擇器狀態的命名習慣

布局檔案

布局檔案應該和將要用於的 android 元件的名稱相匹配，但是這次應以元件的名稱開頭。例如，如果我們為 signinactivity,建立布局檔案，那布局檔案的名稱就應該為 activity_sign_in.xml.

乙個特殊的情況就是在為 adapter 中的子項建立布局的時候，例如，顯示 listview 中的內容。在這種情況下，布局檔案的字首應該為 item_

應該注意到還有乙個特殊情況的存在，那就是在建立乙個布局中的其中一小塊布局時，在這種情況下就應該使用字首 partial_ 。

menu 檔案

與布局檔案的命名的規則相似，menu 檔案也應該和將要用於的 android 元件的名稱相匹配。例如，當我們在為 useractivity 建立 menu 檔案時，那 menu 檔案的名稱就應該是 activity_user.xml

命名規則是不把單詞 menu 作為名稱的一部分，因為這些檔案已經存放在 menu 的檔案下了。

資源檔案

在 values 資料夾中的資源檔案在命名時應該為複數。例如， strings.xml, styles.xml, colors.xml, dimens.xml, attrs.xml