Android开发规范：Java命名规范

文章目录

类名
方法名
变量名

类名

采用大驼峰命名法。

命名规则：功能+类型(Activity、Adapter、Service等)。
举例：
activity类，命名以Activity为后缀，如：LoginActivity
fragment类，命名以Fragment为后缀，如：ShareDialogFragment
service类，命名以Service为后缀，如：DownloadService
broadcastReceiver类，命名以Receiver为后缀，如：JPushReceiver
contentProvider类，命名以Provider为后缀，如：ShareProvider
数据库类，命名以DBHelper为后缀，如：UserDBHelper
adapter类，命名以Adapter为后缀，如：CouponListAdapter
解析类，命名以Parser为后缀，如：NewsParser
工具类，命名以Util为后缀，如：EncryptUtil
模型类，命名以Bean为后缀，如：CouponBean
接口实现类，命名以Impl为后缀，如：ApiImpl
自定义共享基础类，命名以Base开头，如：BaseActivity
测试类，命名以它要测试的类的名称开始，以Test结束。例如：HashTest
注：
抽象类命名后缀加”Abstract”。如：abstract DeviceAbstract。
接口类命名后缀加“Contract”。如：interface DeviceContract。

方法名

采用小驼峰命名法。

命名规则：动词或动名词。如：run()、addCard()。
举例：
初始化方法，命名以init开头，如：initView
按钮点击方法，命名以to开头，如：toLogin
设置方法，命名以set开头，如：setData
具有返回值的获取方法，命名以get开头，如：getData
通过异步加载数据的方法，命名以load开头，如：loadData
布尔型的判断方法，命名以is、has或check，如：isEmpty、checkNull
对数据进行处理，命名以handle或process开头，如：handleUserInfo、processUserInfo
弹出提示框，命名以display或show开头，如：displayAgreement
更新数据，命名以update开头，如：updateXX
保存数据，命名以save开头，如：saveXX
重置数据，命名以reset开头，如：resetXX
清除数据，命名以clear开头，如：clearXX
查询数据，命名以retrieve开头，如：retrieveXX
移除数据，命名以remove开头，如：removeXX
绘制数据，命名以draw开头，如：drawXX
返回Boolean类型数据，命名以is开头，如：isXX

变量名

采用小驼峰命名法。变量命名应该简短有规则。

命名规则：
变量名不应以下划线和美元符号开头。
所有变量都要显示地赋值。
布尔变量应该包含Is，如IsFirstLogin。
参数的命名和方法的命名相同，但是要保证参数名称为一个单词的情况下使参数命名的含义更为明确。
举例：
按照不同的变量类型,变量命名规则有所不同,基本结构为scope+VariableName+Type：
1. 类变量（成员变量）
  非公有的变量前面要加上小写m，
  
  静态变量前面加上小写s，
  
  其它变量以小写字母开头，
  
  常量、静态变量全大写。
  例如：
```
public class MyClass {    public static final int SOME_CONSTANT = 42;    public int publicField;    private static MyClass sSingleton;    int mPackagePrivate;    private int mPrivate;    protected int mProtected;}
```
  注：
  Java的属性变量名都以小写字母开头，如：userName,showMessage等
  比如我们常会定义一些Bean类，里面的变量都是为了生成get和set的。
2. 局部变量
  变量为一个单词，以小写字母开头；
  如：CouponBean bean；
3. 参数：
  同局部变量；
4. 临时变量
  临时变量通常被取名为i、j、k、m和n，它们一般用于整型；c、d、e，它们一般用于字符型。如：for (int i = 0; i < len ; i++)。
5. 类型变量
  类型变量可用以下两种风格之一进行命名：
  单个的大写字母，后面可以跟一个数字(如：E, T, X, T2)。
  或者以类命名方式(参考3.2 类名)，后面加个大写的T(如：RequestT, FooBarT)。
6. 控件变量
  Android中有很多UI控件作为成员变量，为了和java的成员变量区分开了，UI控件类型的成员变量在遵循前面成员变量命名规范的前提下，后面统一再加上控件名称。
  比如：private TextView mDescriptionTextView;
  有些规则是在后面加上控件的缩写，个人感觉缩写不如全名来的美观，而且易于理解。

文章目录

类名

方法名

变量名

更多相关文章

随机推荐