/----------------------------前言--------------------------------/
作为一个程序员,在日常的编码过程中我们必须需要遵循一定的命名规范。可能有的人会反驳,根本不用遵循什么规范,只要能完成功能的代码就是好代码。其实这种想法是很可笑的,我们在正式的开发环境下,往往不是一个人在开发,而且开发过程中可能经常需要进行重构。假如我们编码不遵循一定的规范,而是任意妄为,别人在 看我们代码的时候往往花了大把的时间,还读不懂。就算是自己独立开发,时间久了再回来看以前的代码也是有很大难度的,所以我们有必要去遵循这个规范。一个好的命名规范,会让我们见名知意,很大程度上的帮助我们理解代码。规范!规范!规范!重要的事情说三遍。
/----------------------------转载分割线--------------------------------/
标识符命名法最常用有四种:
- Camel(骆驼)命名法:除首单词外,其余所有单词的第一个字母大写,如:fooBar;
- Pascal命名法:所有单词的第一个字母大写,如:FooBar;
- 下划线命名法:单词与单词间用下划线做间隔,如:foo_bar;
- 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量,首字母小写说明该变量的类型。 量的取名方式为:scope_ prefix_qualifier 范围前缀,类型前缀,限定词,如:g_foo_bar;
安卓App层开发主要是Java语言,所以基本使用除了第四种外的命名方式;
缩写在命名是必须的,遵循下面规则:
- 较短的单词可通过去掉“元音”形成缩写,如icon->ic;
- 较长的单词可取单词的头几个字母形成缩写,如:average->avg;
- 此外还有一些约定成俗的英文单词缩写,如 Internationalization->I18N;
- 程序中不要用缩写,除非该缩写是约定俗成的。
命名规范:
包(packages): 采用反域名命名规则,全部使用小写字母。一级包名为地顶级域名如com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名; 如 com.tinyx.myapp.activities;
类(classes):用Pascal命名法,尽量避免缩写,如:MyActivity;缩写是众所周知的,如HTML,URL;类名称中包含单词缩写,则单词缩写的每个字母均应大写,如:PublicHTML,CommonURL。
接口(interface):与类一样用Pascal命名法,多以able或ible结尾,多用作表示行为,如Runnable,Accessible;
方法(methods):动词或动名词,采用Camel命名法,如:onCreate(),run();下面是一些建议:
- 初始化相关方法,使用init为前缀标识,如:初始化布局initView();
- boolean型使用is或check为前缀标识, 如:checkValue()、isValidate();
- 返回某个值的方法,使用get为前缀标识,如:getName();
- 数据进行处理相关,尽量使用process为前缀标识,如:processUpdate();
- 保存数据相关,使用save为前缀标识,如:saveData();
- 对数据重置的,使用reset前缀标识,如:resetData();
- 清除数据相关,使用clear前缀标识,如:clearData();
- 移除某些项目,使用remove前缀标识,如:removeItem();
- 绘制数据或效果相关的,使用draw前缀标识,如:drawCircle();
变量(variables):采用Pascal命名法,建议采用有意义的命名如:firstName,lastName;
01 |
public
class TestActivity extends
Activity{ |
02 |
private
ZoomableImageView mZoomableView; |
03 |
private
TabLayout mTabLayout; |
04 |
private
int mItemsCount; |
07 |
protected
void onCreate(Bundle savedInstanceState) { |
08 |
super .onCreate(savedInstanceState); |
09 |
setContentView(R.layout.test_activity); |
常量(constants): 全部大写,采用下划线命名法.如下:
1 |
public
static final
int MAX_ITEMS= 10 ; |
2 |
public
static final
String TAG = User. class .getSimpleName(); |
资源文件命名(resources):采用下划线命名法,全部小写,针对不同资源,建议用下面的命名方法;
- drawable资源,加前缀命名:前缀_功能_模块_说明.xml/png/
说明 |
命名范例 |
---|
图标:建议格式 ic_xxx; |
ic_appicon.png |
背景:建议格式 bg_xxx; |
bg_normal_button_default.xml,bg_normal_button_press.xml |
- layout 资源文件,前缀命名:类型_模块_功能_说明.xml,举一些常用的例子如下:
说明 |
命名范例 |
---|
Activity布局文件 |
activity_main.xml |
Fragment布局文件 |
fragment_main.xml |
局部布局View文件 |
view_main_header.xml,view_main_bottom.xml |
自定义提示对话框 |
dialog_alert.xml |
列表项等 |
fragment_user_list_item.xml |
- 动画anim资源文件(anim只有一种资源,所以不必加前缀区分):模块_功能_动画_方向.xml
说明 |
命名范例 |
---|
淡入 |
main_button_fade_in.xml |
淡出 |
main_button_fade_out.xml |
从下方推入 |
button_push_down_in.xml |
从下方推出 |
main_button_push_down_out.xml |
- menu菜单资源文件(menu只有一种资源,所以不必加前缀区分),模块_功能_说明.xml
说明 |
命名范例 |
---|
主界面菜单 |
main_activity.xml |
Fragment界面菜单 |
user_fragment.xml |
1、 ids资源,主要存放是界面控件的id值,用下划线小写命名法,前缀方式:前缀_模块_功能_说明,常用界面控件命名如下:
说明 |
命名范例 |
---|
布局和子控件(ViewGroup,自定义View) |
view_main_topnav |
TextView |
tv_main_title |
Button |
btn_user_add |
ImageButton |
imgbtn_user_del |
ImageView |
img_thumb |
CheckBox |
cb_sex |
RadioButton |
rbtn_answer |
EditText |
et_username |
ToggleButton |
toggle_funtion |
ProgressBar |
pb_download |
SeekBar |
sb_progress |
ProgressBar |
pb_download |
VideoView |
vv_course |
WebView |
wv_download |
RantingBar |
rb_download |
Spinner |
sp_cities |
ScollView |
sv_main |
TextSwitch |
sp_cities |
ListView/ExpandListView/RecyclerView |
lv_cities |
MapView |
mv_location |
2、strings/arrays/dimens资源,用下划线小写命名法,不加任何前后缀,格式,模块_功能_说明
3、attrs/colors/ids的属性和名称使用 Camel命名法; styles的属性使用Camel命名法,名称使用Pascal命名法;如下面:
02 |
< attr
name = "text"
format = "string"
/> |
03 |
< attr
name = "itemIcon"
format = "reference"
/> |
04 |
< attr
name = "showToggle"
format = "boolean"
/> |
05 |
< attr
name = "showVersion"
format = "boolean"
/> |
06 |
< style
name = "Theme.AppCompat.Light.NoActionBar" > |
07 |
< item
name = "windowActionBar" >false</ item > |
08 |
< item
name = "windowNoTitle" >true</ item > |
12 |
< color
name = "colorPrimary" >#009688</ color > |
13 |
< color
name = "colorPrimaryDark" >#00796b</ color > |
14 |
< color
name = "colorAccent" >#cddc39</ color > |
17 |
< item
name = "tabLayout"
type = "id" /> |
18 |
< item
name = "viewPager"
type = "id" /> |
19 |
< item
name = "viewContainer"
type = "id" /> |