Android命名规范

Android开发代码规范相关系列文章:

  1. Android命名规范
  2. Android编码规范

俗话说:无规矩不成方圆,一个项目应该有统一的命名规范,开发者也应该有良好的编码规范,命名规范有以下几点要求:

  • 不能反人类。 曾经见过有个人对Activity这样的命名:
PersonActivityAddCustomer.java

就是以“模块名+Activity+页面名”的命名方式,简直就是奇葩,严重怀疑这个人的人生观、价值观和审美观。

  • 其次,要望文而知义,清晰准确,比如登陆页面的登陆按钮,命名就不能像Button1这样随心所欲,要类似于login_button(资源文件)或者btnLogin(java代码的按钮实例)这样的名称。
  • 此外,遇到MyTextView之类的命名,直接把创建该文件的同学拉出去打100大板,而且要肚皮朝上的那种打法

下面结合个人开发经验,说点具体规则

1. java类命名规范

  • Activity:以Activity作为后缀,比如PersonActivity
  • Adapter:以Adapter作为后缀,比如PersonAdapter
  • Entity:大多数以Entity作为后缀,比如PersonEntity,需要注意,在App开发时会一定一个全局变量User,这个不算做实体,不受此约束。

2. layout目录下的文件命名规范

  • 页面布局文件。以act_为前缀,以Activity所在Package作为中缀,以Activity的名称(去掉Activity后缀)作为后缀,注意都是小写。例如,对于Person模块下的AddCustomerActivity,它的layout文件应该是act_person_addcustomer.xml
  • ListView中的item布局文件。以item_作为固定前缀,列表项的名称为后缀。注意都是小写,例如,某个页面下面有一个用户列表,控件名称为lvUserList,那么item的laout就应该是:item_lv_userlist.xml
  • Dialog布局文件。以dlg_作为固定前缀,Dialog的功能名称作为后缀。注意都是小写,例如,dlg_hint.xml

3. drawable目录下的命名规范。
drawable目录下的资源,大部分都是图片,此外还有一部分xml文件,用于Selector。但无论图片,亦或是Selector文件,都应该遵守以下命名规范

  • 对于只在一个页面使用的资源,就以该页面的名称作为前缀
  • 对于只在一个模块下多个页面使用的资源,就以该模块的名称作为前缀
  • 对于在各个模块、各个页面都有可能是使用的资源,比如说上导航、下导航,就以common作为前缀

4. Java类控件对象的命名规范

控件类缩写+控件的逻辑名称(首字母大写),比如登录按钮,可以命名为btnLogin,下图列出了一些常用控件的缩写

Android命名规范_第1张图片
常用控件缩写

5. Layout中控件的命名规范

  • 可以与Activity中相对应的控件名称保持一致,这样的好处是可以迅速copy-paste出以下代码而杜绝任何的潜在错误。
    但是这样做和传统的Android命名规范就不一致了,至少违反了2条原则,不应该有大写,btn和Login之间没有用下划线进行连接。
Button btnLogin = (Button)findViewById(R.id.btnLogin);
  • 建议写法:控件的功能名称+下划线+控件类名称,注意全部小写,例如登陆按钮,可以命名为login_button

其实两种写法都可以,但必须在项目中做到统一,不要混用,别反人类就行。

你可能感兴趣的:(Android命名规范)