命名规范
-
代码中变量的命名遵照驼峰命名法。
-
布局文件中的控件命名尽量使用控件缩写做前缀,如 TextView 简写为tv_xx,Imageview 简写为 iv_xx。(不强求,有统一的风格即可)
-
图片资源命名规范如下:
- 背景类图片(指图片比较大,一般作为 activity 或者 view 背景的图片),用 bg_ 为前缀,一般为bg_描述。如果背景是有状态的显示的,命名规则为 bg_描述_状态。
- 按钮类图片(可以用 shape 自己实现的就不要用图片了),用 btn_ 为前缀,一般为btn_描述,如果按钮有状态显示的,需要添加状态后缀,如 btn_描述_normal 、btn_描述_focus 、 btn_描述_enabled 。
- 选择框等控件使用的图片用 chx_ 为前缀。
- Dialog 控件使用的图片用 dg_ 为前缀。
- Menu 用到的图片用 menu_ 为前缀。
- 自己用 shape 实现的图片效果用 shape_ 为前缀。
- 其中有状态切换的图片组,在 drawable 文件夹中用 selector_ 为前缀。
-
Layout 文件命名规范如下:
- 如果布局文件是用于 activity ,则用 activity_ 为前缀。
- 如果布局文件是用于 fragment ,则用 fragment_ 为前缀。
- 如果布局文件是用于 ListView GridView RecycleView等 ,则用 item_ 为前缀。
- 如果布局文件是用于自定义 View ,则用 view_ 为前缀。
- 如果布局文件有多处引用使用 ,需要抽取公共引用的布局文件,则用 include_ 为前缀。
-
字符串资源命名规范如下:
有一个规则就是如果字符串可能有多处地方需要使用时,尽量用通用的英文单词含义就可以了(如 ok cancel back 等),对于某些字符串资源只有某些特定的范围使用时准照下面的规则。
- 用于 toast 弹出展示的资源用 toast_ 为前缀。
- 用于 dialog 展示的资源用 dialog_ 为前缀。
- 用于页面上标签展示的资源用 label_ 为前缀。