当前位置:   article > 正文

一些Android 代码的命名规范_android arrays.xml命名

android arrays.xml命名

代码规范挺重要的,自己写出来的东西,不注意规范,阅读困难,会让和你一起工作的人增加烦恼,有时候自己都会弄的乱乱的。所以,代码注意规范很重要,可以让一个团队的人少点烦恼,每天不用加班去想你这是啥意思,能让人可以很好的阅读,给未来接手你项目的人留点活路。

Android 代码的规范:

代码规范先从命名规范开始,Android的命名规范主要涉及:

- Java源代码

- xml文件

- 图片等资源文件


包名

采用反写域名命名规则,即com.xx.xxx.xxxx形式

全部使用小写字母。一级包名为com,二级包名为xx(一般为公司或个人域名),三级包名根据应用进行命名,四级包名为功能模块名。如:

com.taobao.news.activitys

在项目内可以根据功能不同,按照模块划分不同的包名,com.lizhuorui.news.user表示用户模块。

也可以根据层级的不同而划分不同的包名,比如:com.lizhuorui.news.activity,就是Acitivity相关的包。

当然也可以在不同层级里面再按照模块划分包名,比如:com.lizhuorui.news.activity.user,表示和用户有关的Activity。

类和接口

类名称通常是名词或名词短语,一个类如果继承了Android的组件,需在使用该组件的名称作为后缀,这样容易区分该类的作用

例如:  登录页面Activity类      (大驼峰命名:每个单词首字母为大写开头)

public class LoginActivity {}

测试类的命名名称与类的测试,测试结束。例如,hashtest或hashintegrationtest。

接口名称也可以是名词或名词短语,接口一般使用I开头,采用大驼峰命名规,

比如:

public interface IPullToRefresh {}

对于缩写单词要全部大写比如:XMLManage

方法名称

方法名称通常是动词或动词短语,命名规则采用小驼峰命名法,例如:

public void SendMessage(){}

public void stopMessage(){}

一般使用的方法名前缀

例子:

//返回某个值的方法

public void getXX();

//初始化相关方法,比如初始化布局:initView()

public void initXX(){};

//方法为boolean值的时候使用is或者check为前缀

public void checkXX(){};

public void isXX(){};

//保存数据

public void saveXX(){};

//清除数据使用clear或者remove为前缀

public void clearXX(){};

public void removeXX(){};

//更新数据

public void updateXX(){};

//对数据进行处理

public void processXX(){};

//显示某某信息使用dispaly或者show为前缀

public void dispalyXX(){};

public void showXX(){};

//绘制数据或者效果

public void drawXX(){};

变量

Android变量分为三种:成员变量,静态变量和常量。

成员变量

成员变量一般采用小驼峰命名规则,第一单词的首字母小写,其后的首字母大写。变量名一般不使用_和$开头。例如:

private Intent cropIntent;

对于View变量的命名规则,如果View是一个单词的,采用第一个单词小写的方式+对应View的描述进行,例如:

private View viewUserInfo;

如果是两个单词组成的View,比如:TextView,一般采用缩写的方式,例如:

private TextView tvUserName;

一般情况下Button缩写为:btn。

静态变量

为了可以很方便的区分静态变量,静态变量的命名一般采用小写的s开头,后面单词的命名规则和成员变量保持一致,例如:

private static StringBuffer sCacheString;

静态常量

常量命名规则一般是所有的单词都是大写,中间使用_(下划线)分割,例如:

private static final float SCALE_RATE = 1.25f;

为了方便理解和后期的维护,代码中不允许出现单独的字符串或数字常量,比如xx.equals(“1”),单独的字符串或数字这样不利于理解和后期的维护。如果需要使用数据或字符,请按照他们的含义封装成静态常量,或者使用枚举,for语句除外。

Layout布局文件

Layout的命名规则需要和使用他们的组件对应,方便查找和维护,比如我们在创建一个用户信息的UserInfoActivity,对应的Layout的命名就应该是activity_user_info.xml。对应Andorid组件的Layout命名规则:

activity_user_info.xml        // Activity

fragment_sign_up.xml          // Fragment

dialog_change_password.xml    // Dialog

item_user.xml                // AdapterView Item

partial_stats_bar.xml        // Layout文件只是布局文件的一部分

string和color

项目中使用的string和color的值原则上都是必须放在strings.xml和colors.xml中,不要放在Java代码中,这样的好处是可复用,提高维护性,减少非必要的代码。

xml的资源命名,字母全部小写,多个单词之间使用_(下划线)分割.

id命名

layout中使用的id的单词要全部小写,单词之间使用下划线分割,使用名词或者名词词组,应该通过id的命名可以直接理解当前的View要实现的功能.

例如:

@+id/tv_user_name_show

id命名的第一个单词使用View的缩写,如果View只是一个单词,缩写就是当前单词。一般Button的缩写为:btn。

Drawable命名

Drawable的命名规则根据使用的控件来命名,控件的缩写在前面,后面使用表示其功能的一个或者多个单词,中间使用使用_下划线分割。比如:




Drawable是有多个状态的,在命名中体现出状态的不同,比如:



其他资源文件的命名需要遵守Android的规范即可,比如arrays.xml数组文件,dimens.xml分辨的配置,style.xml样式的配置,资源文件的ID命名规则都是字母小写,使用下划线分割的原则。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/weixin_40725706/article/detail/245794
推荐阅读
相关标签
  

闽ICP备14008679号