AS規(guī)范:
編碼格式——UTF-8;
.java、.xml等——完成后,格式化;
刪除多余的資源;
命名規(guī)范
1.包名
包名全小寫,不可有下劃線等,只能是字母,并采用反域名規(guī)則。(一級(jí)包:頂級(jí)域名com,net,org等,二級(jí)包公司名,三級(jí)包應(yīng)用名,后面PBF或者PBL劃分)
個(gè)人比較推薦PBF(按功能分包),原因嗎,誰(shuí)用誰(shuí)知道。
PBL(按層分包),會(huì)很亂,想想每層里面n+的文件,呵呵了。
2.類名
單詞每個(gè)字母均大寫
| 類 | 描述 | 栗子 |
|---|---|---|
| Activity 類 | Activity 為后綴標(biāo)識(shí)歡 | 迎頁(yè)面類 WelcomeActivityAdapter |
| Adapter類 | Adapter為后綴標(biāo)識(shí) | 新聞詳情適配器 NewsDetailAdapter |
| 解析類 | Parser 為后綴標(biāo)識(shí) | 首頁(yè)解析類 HomePosterParser |
| 工具方法類 | Utils 或 Manager 為后綴標(biāo)識(shí) | 線程池管理類:hreadPoolManager 日志工具類:LogUtils(Logger 也可) 打印工具類:PrinterUtils |
| 數(shù)據(jù)庫(kù)類 | 以 DBHelper 后綴標(biāo)識(shí) | 新聞數(shù)據(jù)庫(kù):NewsDBHelper |
| Service 類 | 以Service 為后綴標(biāo)識(shí) | 時(shí)間服務(wù) TimeService |
| BroadcastReceiver 類 | 以 Receiver 為后綴標(biāo)識(shí) | 推送接收 JPushReceiver |
| ContentProvider 類 | 以 Provider 為后綴標(biāo)識(shí) | ShareProvider |
| 定義的共享基礎(chǔ)類 | 以 Base 開頭 | BaseActivity, BaseFragment |
3.方法名
| 方法 | 說(shuō)明 |
|---|---|
| initXX() | 初始化相關(guān)方法,使用 init 為前綴標(biāo)識(shí),如初始化布局initView() |
| isXX(), checkXX() | 方法返回值為 boolean 型的使用 is/check 為前綴標(biāo)識(shí) |
| getXX() | 返回某個(gè)值的方法,使用 get 為前綴標(biāo)識(shí) |
| setXX() | 設(shè)置某個(gè)屬性值 |
| handleXX(), processXX() | 對(duì)數(shù)據(jù)進(jìn)行處理的方法 |
| displayXX(), showXX() | 彈出提示框和提示信息,使用 |
| display/show | 為前綴標(biāo)識(shí) |
| updateXX() | 更新數(shù)據(jù) |
| saveXX(), insertXX() | 保存或插入數(shù)據(jù) |
| resetXX() | 重置數(shù)據(jù) |
| clearXX() | 清除數(shù)據(jù) |
| removeXX(), deleteXX() | 移除數(shù)據(jù)或者視圖等,如 removeView() |
| drawXX() | 繪制數(shù)據(jù)或效果相關(guān)的,使用 draw |
4.常量名
常量全部大寫
5.非常量名
非公有,非靜態(tài)字段命名以 m 開頭。
靜態(tài)字段命名以 s 開頭。
6.動(dòng)畫資源文件
| 名稱 | 說(shuō)明 |
|---|---|
| fade_in | 淡入 |
| fade_out | 淡出 |
| fade_out | 從下方推入 |
| push_down_out | 從下方推出 |
| push_left | 推向左方 |
| slide_in_from_top | 從頭部滑動(dòng)進(jìn)入 |
| zoom_enter | 變形進(jìn)入 |
| slide_in | 滑動(dòng)進(jìn)入 |
| shrink_to_middle | 中間縮小 |
7.圖片資源文件drawable和mipmap
res/drawable/ 目錄下放的是位圖文件(.png、.9.png、.jpg、.gif)或編譯為可繪制對(duì)象資源子類型的 XML 文件,
而 res/mipmap/ 目錄下放的是不同密度的啟動(dòng)圖標(biāo),所以 res/mipmap/ 只用于存放啟動(dòng)圖標(biāo),其余圖片資源文件都應(yīng)該放到 res/drawable/ 目錄下。
| 名稱 | 說(shuō)明 |
|---|---|
| btn(bg)_main_me | 類型_模塊名 _邏輯名稱 |
| ic_image | 類型_邏輯名稱 |
| divider_color | 類型_顏色 |
| def(sel)_search_all | 類型_模塊名 _邏輯名稱 |
多種形態(tài)
| 名稱 | 說(shuō)明 |
|---|---|
| btn_xx_normal | btn_類型_狀態(tài) |
| pressed | 點(diǎn)擊 |
| focused | 焦點(diǎn) |
| disabled | 不可用效果 |
| checked | 選中 |
| selected | 選中 |
| hovered | 懸停效果 |
| checkable | 可選 |
| activated | 激活效果 |
8.資源文件
統(tǒng)一——類型_模塊名 _邏輯名稱
單詞縮寫
| 名稱 | 縮寫 |
|---|---|
| Button | btn |
| CheckBox | cb |
| EditText | et |
| FrameLayout | fl |
| GridView | gv |
| ImageButton | ib |
| ImageView | ib |
| LinearLayout | ll |
| ListView | lv |
| ProgressBar | pb |
| RadioButtion | rb |
| RecyclerView | rv |
| RelativeLayout | rl |
| ScrollView | sv |
| SeekBar | sb |
| Spinner | spn |
| TextView | tv |
| ToggleButton | tb |
| VideoView | vv |
| WebView | wv |