Android开发必备:命名规范

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

  1. Camel(骆驼)命名法:除首单词外,其余所有单词的第一个字母大写,如:fooBar;
  2. Pascal命名法:所有单词的第一个字母大写,如:FooBar;
  3. 下划线命名法:单词与单词间用下划线做间隔,如:foo_bar;
  4. 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量,首字母小写说明该变量的类型。 量的取名方式为:scope_ prefix_qualifier 范围前缀,类型前缀,限定词,如:g_foo_bar;

安卓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;

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

常量(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
  • values资源,这个主要分下面几种资源:

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命名法;如下面:

 1 <!--attrs-->
 2 <attr name="text" format="string" />
 3 <attr name="itemIcon" format="reference" />
 4 <attr name="showToggle" format="boolean" />
 5 <attr name="showVersion" format="boolean" />
 6 <style name="Theme.AppCompat.Light.NoActionBar">
 7         <item name="windowActionBar">false</item>
 8         <item name="windowNoTitle">true</item>
 9 </style>
10
11  <!--colors-->
12  <color name="colorPrimary">#009688</color>
13  <color name="colorPrimaryDark">#00796b</color>
14  <color name="colorAccent">#cddc39</color>
15
16  <!--ids-->
17  <item name="tabLayout" type="id"/>
18  <item name="viewPager" type="id"/>
19  <item name="viewContainer" type="id"/>

转自http://blog.tinyx.cc/android-naming.html

时间: 2024-12-20 11:16:02

Android开发必备:命名规范的相关文章

Android 文件夹命名规范 国际化资源

? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86

Android 开发必备

Android 开发必备 http://www.androiddevtools.cn/ 收集整理Android开发所需的Android SDK.开发中用到的工具.Android开发教程.Android设计规范,免费的设计素材等. http://wear.techbrood.com Android developer 最新国内镜像:http://wear.techbrood.com,包含Android最新文档以及Android Wear,Android TV,Android Auto各个子领域方面

RecyclerView的使用(Android开发必备,替换掉ListView)

RecyclerView的使用(Android开发必备,替换掉ListView) 当有人看了你写的代码,说你现在还在使用ListView?是不是感觉快跟不上时代了啊!不错,今天就带给大家一个ListView的最新升级控件RecyclerView,Android 5.0推出的新控件,不过它在support-v7包,可以往下兼容,当你学会了RecyclerView之后,发现了它的强大,你就会替换到ListView和GridView了.    RecyclerView简介:          Recy

android编码及命名规范

Android编码规范 类名: 大驼峰 (pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写 方法函数: 小驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写. 常量: 下划线命名法:单词与单词间用下划线做间隔.全部大写! 代码中一些定义的变量规范: 成员变量:m_***             局部变量:l_***          形参:a_*** 常量:大写_***                  枚举值:em_*** Layout xml

Android开发必备的21个免费资源和工具

转载自: http://blog.csdn.net/shimiso/article/details/6788375 Android移动开发平台现在不是一个“火”字能形容的,今年Android平台在市场占有率上相比去年取得的886%增长!如果我只看增长率,iPhone据统计才有61%的增长.而创造了山寨概念的联发科也在近期宣布将进军Android.这些事实可以给你关于两个平台流行度的印像,但是事实上,这些数据告诉了智能机开发员的谁才是真正的赢家.在时下,智能机越来越流行,因此成为一个快速增长的An

Android开发代码格式规范

书写规范 1. 编码方式统一用UTF-8. Android Studio默认已是UTF-8,只要不去改动它就可以了. 2. 缩进统一为4个空格,将Tab size设置为4则可以保证tab键按4个空格缩进.另外,不要勾选上Use tab character,可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式. 3. 花括号不要单独一行,和它前面的代码同一行.而且,花括号与前面的代码之间用一个空格隔开. public void method() { // Good } publ

Android开发之——编码规范

1. 前言 这份文档参考了 Google Java 编程风格规范和 Google 官方 Android 编码风格规范.该文档仅供参考,只要形成一个统一的风格,见量知其意就可. 2. 源文件基础 2.1 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java. 2.2 文件编码:UTF-8 源文件编码格式为 UTF-8. 2.3 特殊字符 2.3.1 空白字符 除了行结束符序列,ASCII水平空格字符(0x20,即空格)是源文件中唯一允许出现的空白字符,这意味着: 所有其它字符串

【Bugly 技术干货】Android开发必备知识:为什么说Kotlin值得一试

1.Hello, Kotlin Bugly 技术干货系列内容主要涉及移动开发方向,是由 Bugly邀请腾讯内部各位技术大咖,通过日常工作经验的总结以及感悟撰写而成,内容均属原创,转载请标明出处. 1.1 Kotlin的身世 写了许久Java,有没有发现其实你写了太多冗余的代码? 后来你体验了一下Python,有没有觉得不写分号的感觉真是超级爽? 你虽然勤勤恳恳,可到头来却被NullPointerException折磨的死去活来,难道就没有受够这种日子么? 直到有一天你发现自己已经写了好几十万行代

Android开发必备技能——修改debug签名

前言 从事Android开发的小伙伴们,想必都会遇到这样的问题.当你的应用中需要集成百度地图.极光推送等第三方平台时,会去申请一个叫做AppKey的东西.与此同时,你得提供下应用签名信息的MD5或SHA1.然后就悲催的发现,只有用指定的签名文件打包时,该功能才能正常使用.如果你用的是开发工具的debug keystore签名信息,直接run一下就好,如果你用的是APP发布时候的keystore,每次测试时都得export 一个apk.心中一万只草泥马在奔腾的有木有? 楼主之前的小伎俩就是,去申请