变量命名要做到足够长有一定意义,同时又足够短以避免冗长。
关于携带Android控件的变量,个人建议规则:【控件逻辑名称】+【控件缩写】
如mLoginBtn, mBottomLayout, mTitleText, 能用全名的可以尽量用全名不用缩写如mLoginButton,
但绝对不要写成mDialog1, mDialog2, mBtn1, mBtn2等等这样的。命名要做到见名知义。
2. 局部变量
局部变量也是按照驼峰规则命名,前面不用加m, 如loginBtn,resultString,loginPresenter,
不能有下划线之类的如myname_text, btn_commit。命名要做到见名知义。
尽量用简洁的单词描述,但是避免单个字符如a, b,i,j, 除非是临时变量循环变量在for循环中使用。
常见单词的缩写:
| 单词 | 缩写 |
| — | — |
| icon | ic |
| background | bg |
| foreground | fg |
| initial | init |
| information | info |
| success | succ |
| failure | fail |
| error | err |
| image | img |
| library | lib |
| message | msg |
| password | pwd |
| length | len |
| buffer | buf |
| position | pos |
能用全称的尽量用全称不用缩写。另外缩写尽量不要使用拼音和英文及数字混拼。
3. 静态变量/常量
不同于前两种,静态常量(static/final)一般应该全部大写,中间用下划线分开。命名要做到见名知义。
4. 方法名
采用驼峰命名规则。首单词首字母小写,其余单词首字母大写。尽量不要使用下划线。
命名要做到见名知义。函数名如果过长,部分常见单词可以采用缩写表示。
方法名通常是动词或动词短语。
| 方法 | 说明 |
| — | — |
| initXX() | 初始化相关方法,使用init为前缀标识,如初始化布局initView() |
| isXX() checkXX() | 方法返回值为boolean型的请使用is或check为前缀标识 |
| getXX() | 返回某个值的方法,使用get为前缀标识 |
| setXX() | 设置某个属性值 |
| handleXX()/processXX() | 对数据进行处理的方法 |
| displayXX()/showXX() | 弹出提示框和提示信息,使用display/show为前缀标识 |
| updateXX() | 更新数据 |
| saveXX() | 保存数据 |
| resetXX() | 重置数据 |
| clearXX() | 清除数据 |
| removeXX() | 移除数据或者视图等,如removeView(); |
| drawXX() | 绘制数据或效果相关的,使用draw前缀标识 |
5. 控件Id
全部采用小写,单词之间使用下划线分割。命名要做到见名知义。避免btn1, btn2, mynametextview这样的。
个人建议xml中的资源id命名规则以:【控件缩写】+【控件逻辑名称】(跟代码中反过来)为主,
例:
-
btn_login
-
edit_accout
-
iv_message
-
lv_news
-
tv_name
常用控件的缩写
| 控件 | 布局文件中缩写 | 代码中缩写 |
| — | — | — |
| LinearLayout | ll_xxx | xxxLay或xxxLayout |
| RelativeLayout | rl_xxx | xxxRLayout |
| FrameLayout | fl_xxx | xxxFLayout |
| TextView | tv_xxx | xxxTv或xxxTextView |
| EditText | edit_xxx | xxxEt或xxxEdit |
| Button | btn_xxx | xxxBtn或xxxButton |
| ImageView | iv_xxx | xxxIv或xxxImg |
| CheckBox | chk_xxx | xxxChk或xxxCheckBox |
| RadioButton | rbtn_xxx |
xxxRbtn或xxxRadioButton
|
| ProgressBar | pbar_xxx | xxxPbar或xxxProgressBar |
| ListView | lv_xxx |
xxxLv或xxxListView
|
| WebView | wv_xxx |
xxxWv或xxxWebView
|
| GridView | gv_xxx |
xxxGv或xxxGridView
|
6. strings.xml dimens.xml colors.xml等变量命名
strings.xml
strings的name命名使用下划线命名法,采用以下规则:模块名+逻辑名称,这样方便同一个界面的所有string都放到一起,方便查找。
| 名称 | 说明 |
| — | — |
| main_menu_about | 主菜单按键文字 |
| friend_title | 好友模块标题栏 |
| friend_dialog_del | 好友删除提示 |
| login_check_email | 登录验证 |