Android 編程規范指南

一.目錄規范

1.系統目錄規范
Requirement：需求文檔； Design：設計文檔；
Planning&Log：計劃、日志、會議；
Test：集成測試、系統測試、測試報告；
Study：學習資料、demo等；
Deployment：發布、部署等；
Source：源代碼以及單元測試；
Help：相關幫助文檔；

2.源碼目錄規范
目錄即包（package）；目錄下所有類都屬於這個命名空間，一主類一文件；
目錄層次遞歸；一般系統命名空間目錄最好不要超過3層；

二.代碼編碼規范

1.常見的命名規范
pascal命名法（Delphi）：每個單詞首字母大寫；
camel命名法（駝峰命名法）：第一個單詞首字母小寫，後面的單詞都大寫；
匈牙利命名法（VB）：用前綴標定特征和屬性；如mName;
下劃線命名法：用下劃線來分割；如常量；

2.Android命名特點：
包：全部小寫；
文件命名：文件名即類名；
類命名：（普通類）pascal命名法；（自定義屬性類）加上Attribute；（自定義異常類）加上Exception；（泛型類型傳遞）K、T；
方法命名：pascal命名用於構造函數；camel命名用於普通函數；動賓短語；
接口命名：一般加後綴命名；
變量命名：（類中）私有成員變量（mMyName）、公有變量、靜態變量（sMyName）；局部變量（camel）；方法參數（camel）；循環變量（無意義的字母）；
優化：局部變量以_打頭，參數變量以p打頭；

3.格式化：
嚴格換行：一個冒號換一行；｛｝各占一行；
嚴格縮進：使用Tab縮進；重視縮進和代碼縮進對齊； 嚴格注釋：文件，類，方法，方法參數，變量，屬性；文件和類一定要包含如下元素：Name，Description，Version，Date,Author,Change,Copyright；
聲明的位置：相似的import放在一起，可以很清晰；成員變量放在最前面，最好不要穿插來放；局部變量也放在局部方法前面；
使用java預定義類型而不使用類名聲明變量；

三、代碼邏輯規范

1.避免將多個類放在一個文件裡面，除非是一次性使用的內部類；
2.一個方法的代碼長度最好不要超過35行；
3.原則上，盡量不要手動修改機器產生的代碼；
4.final String代替直接的“String”，同理int；
5.不要在正常循環語句中，進行直接的return操作；
6.不要用goto語句；
7.處處要考慮異常，特別是I/O操作，多進行try...catch操作；
8.僅僅對外公布的才使用public，其他的使用private or internal；
9.盡量不要提供public and protected 程序標量，使用屬性代替他們；
10.不要在系統自動生成的函數直接些業務代碼，最好自定義函數，然後調用；
11.總是使用借口，推薦使用顯示接口實現；
12.在switch語句中總是要有default字句來顯示信息；