你不可不看的Android开发命名规范

时间:2023-12-06 11:48:02

标识符命名法最要有四种:

  • 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; 模型类变量默认以上规则
public class User {
public String name;
public String phone;
public int sex; //1,男 2,女 public User() {
this.name = "myname";
this.phone = "123“
this.sex = 0;
}
}
  • 非模型类全局参数建议加上小写m开头;
public class TestActivity extends Activity{
private ZoomableImageView mZoomableView;
private TabLayout mTabLayout;
private int mItemsCount; @Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.test_activity);
}
}

更多细节请访问原文:

你不可不看的Android开发命名规范