一個好的命名規範可以給團隊或後期維護帶來很大的便利
Android APP開發命名規範
編輯人
安前鬆
編輯日期
2016年7月23日
版本
V1.0.0
宣告
在此次開發過程中需要嚴格遵守命名規則，如果有違背此命名規範命名的跡象，則自己承擔相應的責任，此文件未經批准，嚴禁擅自修改。
出發點
①、為了有效，快速研發
②、為了團隊一致性，在後面bug修改時便於查詢
③、增加程式碼可讀性
④、實現後期可維護性
命名規範
| Java |
嚴格準守駝峰式命名 ①包名一律為小寫字母，並且要見名知義，如：com.android.activity ②類名必須以大寫字母開頭，後面每個單詞進行駝峰式命名，並且要見名知義。如：MainActivity |
||||||||||||||||||||
| 包名 |
一級包名為com，二級包名為android，三級包名為工程名稱（如：TaoBao），四級包名根據某一類class的集合來命名（如：activity,adapter,fragment等），五級以後包名根據自己需求，要見名知義。 |
||||||||||||||||||||
| 類 |
要見名知義 ①Activity：以Activity結尾，如果當前頁面是店鋪頁面，參考命名為ShopActivity ②Fragment：以Fragment結尾，如果當前頁面為店鋪頁面，參考命名為 ③BroadCastReceiver：以Receiver結尾，如果當前廣播為網路廣播，參考命名為NetReceiver ④Service：以Service結尾，如果當前有一個音樂Service，參考命名為MusicService ⑤自定義View：以X開頭，如XListView ⑥Adapter：以adapter結尾，如店鋪頁面的介面卡，參考命名為ShopAdapter ⑦工具類：以Utils或者Manager或者Helper結尾，比如網路工具類參考命名為NetUtils/NetManager/NetHelper ⑧常量類：以Constant結尾，如URL常量，參考命名為 ⑨Interface:以I開頭，如IHome ⑩列舉：以E開頭，如EStatus 其他： Ⅰ實體類:以Entity結尾或者M開頭，比如學生實體類，參考命名為StudentEntity/MStudent Ⅱ：抽象類:以A開頭，比如學生抽象類，參考命名：AStudent Ⅲ：Dialog：以Dialog結尾，如選擇對話方塊，參考命名為ChoiceDialog Ⅳ：PopWindow：以Pop結尾，如選擇popwinwindow，參考命名為ChoicePop。 Ⅴ：網路類：以Service結尾，如首頁網路請求，參考命名為：HomeService 其他無舉例者嚴格按照見名知義命名 |
||||||||||||||||||||
| 控制元件 |
FrameLayout：以fl開頭 LinearLayout：以ll開頭 RelativeLayout：以rl開頭 GridView：以gv開頭 ListView：以lv開頭 TextView：以tv開頭 Button：以btn開頭 CheckBox：以check開頭 ToggleButton:以btn開頭 ImageButton：以btn開頭 ImageView：以iv開頭 ProgressBar：以pb開頭 WebView：以wv開頭 ScrollView：sc開頭 VideoView：video開頭 HorizontalScrollView：以sc開頭 EditText：et開頭 |
||||||||||||||||||||
| 方法 常量 變數 |
①方法命名必須以小寫開頭，接下來每個單詞駝峰式命名，見名知義，引數名亦如此。 ②常量要統一使用final static來修飾，並且所有字母大寫，每個單詞之間用下劃線(_)連線 ③變數命名以小寫開頭，要見名知義 補充：所有用到常量的地方要統一將常量寫在常量中去引用，而不是哪裡用哪裡寫 參考：
|
||||||||||||||||||||
| 資原始檔 |
資原始檔統一都是小寫，每個單詞與每個單詞之間用下劃線（_）來連線，而不是駝峰式命名 ①動畫：需以_anim結尾 ②drawable：如果是圖片資原始檔，則按照該圖片的用處來命名 如果是xml檔案，則以drawable_開頭 ③layout：如果是activity佈局則以activity_開頭，如果是fragment則以fragment_開頭，如果是ListView的item，則以item_開頭，如果是Dialog,則以dialog_開頭，如果是PopWindow，則以pop_開頭，其他則以layout_開頭 ③colors：以color_開頭，如color_red ④string:如果是標題則以label_of_開頭，如果是button，則以btn_of_開頭，如果是hint，則以hint_of_開頭，其他則以string_開頭。 |
||||||||||||||||||||
| 佈局id |
以上面控制元件縮寫開頭，並以下劃線(_)連線每個單詞,所有顏色，尺寸，字串等必須寫在對應的資原始檔中去。如果是假資料則不用，但是在實現網路請求後，一定要在佈局中將假資料去掉，以免造成上線後帶來一些問題。 |
註釋
| 類 |
註釋該類代表什麼，給予一些註釋，增加程式碼可閱讀性。 |
| 方法 |
註釋該方法是用於做什麼，每個方法的引數分別代表什麼 |
| 變數/常量 |
註釋該變數或者常量代表什麼 |
| 控制元件/佈局 |
註釋該控制元件代表什麼，該佈局代表什麼 |
註釋規範
單行註釋：//+空格+註釋內容格式化，如Button btn_login;// 登陸按鈕
多行註釋：/**/，一般不用
文件註釋：/***/,除屬性/變數外，其他儘量用文件註釋，少用多行註釋,如：
/**
*獲取名稱
*@param name 名稱
*/
private void getName(String name){
......
}
程式碼格式
統一使用Ctrl+Alt+L進行程式碼格式化