Android命名规范

作者: 木木00 | 来源:发表于2017-03-20 13:54 被阅读76次

    作者简介 原创微信公众号郭霖 WeChat ID: guolin_blog

    大家早上好,新的一周开始啦!

    本篇来自TinyX的投稿,讲解了Android中的命名规范,供大家参考。毕竟好的命名能起到注释的作用!

    TinyX的博客地址:

    http://blog.tinyx.cc

    正文

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

    1. Camel(骆驼)命名法:除首单词外,其余所有单词的第一个字母大写,如:fooBar;

    2. Pascal命名法:所有单词的第一个字母大写,如:FooBar

    3. 下划线命名法:单词与单词间用下划线做间隔,如:foo_bar;

    4. 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量,首字母小写说明该变量的类型。 变量的取名方式为:scope_ prefix_qualifier 范围前缀,类型前缀,限定词,如:g_foo_bar("g_"表示全局变量);

    安卓App层开发主要是Java语言,所以基本使用除了第四种外的命名方式;

    缩写在命名是必须的,遵循下面规则:

    1.较短的单词可通过去掉“元音”形成缩写,如icon->ic;

    2.较长的单词可取单词的头几个字母形成缩写,如:average->avg;

    3.此外还有一些约定成俗的英文单词缩写,如 Internationalization->I18N;

    4.程序中不要用缩写,除非该缩写是约定俗成的。

    命名规范:

    包(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;

    模型类变量默认以上规则:

    非模型类全局参数建议加上小写m开头:

    常量(constants):全部大写,采用下划线命名法.如下:

    资源文件命名(resources):采用下划线命名法,全部小写,针对不同资源,建议用下面的命名方法;

    drawable资源,加前缀命名:前缀_功能_模块_说明.xml/png

    layout 资源文件,前缀命名:类型_模块_功能_说明.xml,举一些常用的例子如下:

    动画anim资源文件(anim只有一种资源,所以不必加前缀区分):模块_功能_动画_方向.xml

    menu菜单资源文件(menu只有一种资源,所以不必加前缀区分),模块_功能_说明.xml

    values资源,这个主要分下面几种资源:

    1.ids资源,主要存放是界面控件的id值,用下划线小写命名法,前缀方式:前缀_模块_功能_说明,常用界面控件命名如下:

    2.strings/arrays/dimens资源,用下划线小写命名法,不加任何前后缀,格式,模块_功能_说明

    3.attrs/colors/ids的属性和名称使用 Camel命名法; styles的属性使用 Camel命名法,名称使用 Pascal命名法;如下面:

    完。。。。。。。。。。。。。。。。。。。。。

    文章原创作者GuoLin 书籍推荐

    郭林大神原创android 书籍:《第一行代码 android》

    淘宝链接: https://s.click.taobao.com/t?e=m%3D2%26s%3DgKUfuKdAZKocQipKwQzePOeEDrYVVa64K7Vc7tFgwiHjf2vlNIV67p2n%2BQBNMyE6Rku8%2Bpj6eJall3bs%2B3NRhNHnsKI%2BqxhyM0iVZhTFBom4YIorMPnmg8G0g2OJi%2FzmXHfenomYtn5EW9vzeG8LzfPUwktUBEmkxg5p7bh%2BFbQ%3D&pvid=10_106.6.161.154_3367_1490163222155

    相关文章

      网友评论

      本文标题:Android命名规范

      本文链接:https://www.haomeiwen.com/subject/vpobnttx.html