zoukankan      html  css  js  c++  java
  • Android命名规范

    Android 命名规范

    刚 接触android的时候,命名都是按照拼音来,所以有的时候想看懂命名的那个控件什么是什么用的,就要读一遍甚至好几遍才知道,这样的话,在代码的审查 和修改过程中就会浪费不少不必要的时间。如果就是我一个人开发,一个人维护的话还好,可是如果一个项目是团队分工合作,这样让你的同事去看你的代码就更加 吃力了,因为大家之间的编程方式不一样,所以,在开发过程中,命名规范统一尤为重要,最好是团队中统一好大家命名方法,这样对于日后的工作会轻松很多。

    在面试的时候,审核一个程序员的编程水平的时候,命名规范也是一大标准,所以,下面我就总结下我从网上别人的经验和自己的感悟中收集总结的android命名规范,希望对大家有所帮助。

    提醒:在命名规范的统一下,在加上注释,这样日后维护会高效快捷好多。

    先初略介绍下当前主要的标识符命名法和英文缩写规则:(这段别人那边借鉴的)

    在讲解命名规范前,先初略介绍下当前主要的标识符命名法和英文缩写规则。

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

    1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写。

    2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写

    3 下划线命名法:单词与单词间用下划线做间隔。

    4 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量前附加小写序列说明该变量的类型。 量的取名方式为:<scope_> + <prefix_> + <qualifier>范围前缀,类型前缀,限定词。

    个人觉得标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义。

    英文缩写原则:
    1 较短的单词可通过去掉“元音”形成缩写
    2 较长的单词可取单词的头几个字母形成缩写
    3 此外还有一些约定成俗的英文单词缩写.

    下面为常见的英文单词缩写:
    你必须知道的Android命名规范 - 第1张  | 爱编程网

    命名规范:

    1  包(packages): 采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名

    你必须知道的Android命名规范 - 第2张  | 爱编程网

    2  类(classes):名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的,  比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。

    你必须知道的Android命名规范 - 第3张  | 爱编程网

    3  接口(interface):命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如interface Runna ble ;
    interface Accessible 。

    4  方法(methods):动词或动名词,采用小驼峰命名法例如:onCreate(),run()
    你必须知道的Android命名规范 - 第4张  | 爱编程网

    5  变量(variables)采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。

    用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。
    量词列表:量词后缀说明
    First  一组变量中的第一个
    Last   一组变量中的最后一个
    Next   一组变量中的下一个变量
    Prev   一组变量中的上一个
    Cur    一组变量中的当前变量

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

    7  资源文件(图片drawable文件夹下):全部小写,采用下划线命名法,加前缀区分

    命名模式:activity名称_逻辑名称/common_逻辑名称

    如果有多种形态如按钮等除外如btn_xx.xml(selector)

    你必须知道的Android命名规范 - 第5张  | 爱编程网

    命名后缀:

    你必须知道的Android命名规范 - 第6张  | 爱编程网

    8     资源布局文件(XML文件(layout布局文件)):

    全部小写,采用下划线命名法

    1).contentview命名, Activity默认布局,以去掉后缀的Activity类进行命名。不加后缀:

    功能模块.xml

    例如:main.xml、more.xml、settings.xml

    或则:activity_功能模块.xml

    例如:activity_main.xml、activity_more.xml

    2).Dialog命名:dialog_描述.xml

    例如:dlg_hint.xml

    2).PopupWindow命名:ppw_描述.xml

    例如:ppw _info.xml

    3). 列表项命名listitem_描述.xml

    例如:listitem_city.xml

    4).包含项:include_模块.xml

    例如:include_head.xml、include_bottom.xml

    5).adapter的子布局:功能模块_item.xml

    例如:main_item.xml、

    9   动画文件(anim文件夹下):全部小写,采用下划线命名法,加前缀区分。

    //前面为动画的类型,后面为方向

    你必须知道的Android命名规范 - 第7张  | 爱编程网

    10    资源ID(resourcesid):大小写规范与方法名一致,采用小驼峰命名法。命名规范为“资源控件的缩写  名”+“变量名”。注意:页面控件名称应该和控件id名保持一致

    strings.xml,colors.xml等中的id命名:

    命名模式:activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称

    strings.xml中,使用activity名称注释,将文件内容区分开来

    11   layout中的id命名

    命名模式为:view缩写_模块名称_view的逻辑名称

    view的缩写详情如下:

    你必须知道的Android命名规范 - 第8张  | 爱编程网

    12.activity中的view变量命名

    命名模式为:逻辑名称+view缩写

    建议:如果layout文件很复杂,建议将layout分成多个模块,每个模块定义一个moduleViewHolder,其成员变量包含所属view

    13.styles.xml:将layout中不断重现的style提炼出通用的style通用组件,放到styles.xml中;

    14.使用layer-list和selector

    Android编码规范建议(别人弄的觉得蛮有道理)

    1.java代码中不出现中文,最多注释中可以出现中文

    2.局部变量命名、静态成员变量命名

    只能包含字母,单词首字母除第一个外,都为大写,其他字母都为小写

    3.常量命名

    只能包含字母和_,字母全部大写,单词之间用_隔开

    4.图片尽量分拆成多个可重用的图片

    5.服务端可以实现的,就不要放在客户端

    6.引用第三方库要慎重,避免应用大容量的第三方库,导致客户端包非常大

    7.处理应用全局异常和错误,将错误以邮件的形式发送给服务端

    8.图片的.9处理

    9.使用静态变量方式实现界面间共享要慎重

    10.Log(系统名称模块名称接口名称,详细描述)

    11.单元测试(逻辑测试、界面测试)

    12.不要重用父类的handler,对应一个类的handler也不应该让其子类用到,否则会导致message.what冲突

    13.activity中在一个View.OnClickListener中处理所有的逻辑

    14.strings.xml中使用%1$s实现字符串的通配

    15.如果多个Activity中包含共同的UI处理,那么可以提炼一个CommonActivity,把通用部分叫由它来处理,其他activity只要继承它即可

    16.使用button+activitgroup实现tab效果时,使用Button.setSelected(true),确保按钮处于选择状态,并使activitygroup的当前activity与该button对应

    17.如果所开发的为通用组件,为避免冲突,将drawable/layout/menu/values目录下的文件名增加前缀

    18.数据一定要效验,例如

    字符型转数字型,如果转换失败一定要有缺省值;

    服务端响应数据是否有效判断

    最后,这些都是一些个人总结和网络上看来的其他网友的建议,

    仅供参考,只要形成一个团体上的统一即可,简单知道他的意思就可以了。

    程序员养成良好的编码习惯和命名规范,对于自己和整个团队都有好处。

    (转自爱编程网  http://www.icoding.net/android-named-rules.html)

  • 相关阅读:
    随机森林算法参数调优
    BAYES和朴素BAYES
    阿里云 金融接口 token PHP
    PHP mysql 按时间分组 表格table 跨度 rowspan
    MySql按周,按月,按日分组统计数据
    PHP 获取今日、昨日、本周、上周、本月的等等常用的起始时间戳和结束时间戳的时间处理类
    thinkphp5 tp5 会话控制 session 登录 退出 检查检验登录 判断是否应该跳转到上次url
    微信 模板消息
    php 腾讯 地图 api 计算 坐标 两点 距离 微信 网页 WebService API
    php添加http头禁止浏览器缓存
  • 原文地址:https://www.cnblogs.com/codingWarrior/p/4870700.html
Copyright © 2011-2022 走看看