Android 命名规范

1.命名规范的目的:
方便项目组成员协调开发工作,便于后期开发人员理解和维护代码。因为一个软件的生命周期中,80%的花费在于维护。几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。所以编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。
2.命名规则
因为Android编程语言使用JAVA,所以遵循JAVA标识符命名规则。
1)标识符由字母、数字、下划线、美元符号、人民币符号组成,并且首字母不能是数字。
2)不能把关键字和保留字作为标识符。
3)标识符没有长度限制。
4)标识符对大小写敏感。
3.命名规范
1)大驼峰命名:由一个单词组成,首字母大写,其余小写;由多个单词组成,每个单词的首字母均大写,其余小写。
1.1)适用于类名、接口名
1.2)格式:public class Sam public class SamDoc
2)小驼峰命名:由一个单词组成,全部小写;由多个单词组成,第一个单词全小写,则从第二个单词开始首字母大写。
2.1)适用于函数名、变量名
2.2 ) 格式:public void init() public void initView()
3)下划线命名:单词与单词之间用下划线分隔开。
3.1)适用于常量 、layout命名、控件id、layout命名、资源文件
3.2)常量:private static final int UPDATE_VERSION_Setting = 1;
控件id:TextView @+id/tv_book_name_show ;
layout命名:activity_file_accept.xml
资源文件:menu_icon_navigate.png

以下摘抄来自于此链接
https://github.com/artwl/AndroidNote/blob/master/Android%E5%9F%BA%E7%A1%80/Android%E7%BC%96%E7%A0%81%E8%A7%84%E8%8C%83.md

4.具体命名
4.1)包名
命名规则:一个唯一包名的前缀总是全部小写的 ASCII字母并且是一个顶级域名,是com,edu,gov,mil,net,org。包名的后续部分根据不同各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部分(department),项目(project),机器(machine),或注册名(login names)。
例如:com.domin.xx
包命名必须以 com.domin. 开始,后面跟有项目名称(或者缩写),再后面为模块名或层级名称。
如:com.domin.项目缩写.模块名com.domin.xx.bookmark
如:com.domin.项目缩写.层级名com.domin.xx.activity
4.2)类和接口命名
命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,
避免缩写词(除非该缩写词被更广泛使用,像 URL,HTML)
接口一般要使用able,ible,er等后缀
4.3)方法的命名
4.3.1 ) 命名规则:方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。(小驼峰法)
例如:public void run(); public String getBookName();
4.3.2 ) 类中常用方法的命名:
类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上 get
如 getFirstName(), getLastName();
4.3.3 ) 一般来说,get前缀方法返回的是单个值,find前缀的方法返回的是列表值.
类的设置方法(一般返回类型为 void):被访问字段名的前面加上前缀 set
如 setFirstName(), setLastName();
4.3.4 ) 类的布尔型的判断方法一般要求方法名使用单词 is 或 has 做前缀.
如 isString() 或者使用具有逻辑意义的单词,例如 equal 或 equals.
4.3.5 ) 类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用动词,首字母小写.
如 openFile(),addCount()
4.3.6 )构造方法应该用递增的方式写,(参数多的写在后面).
toString()方法:一般情况下,每个类都应该定义toString()
4.4)变量命名
命名规则:第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。
变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为 m、n、k 它们一般用于整型;
c、d、e 它们一般用于字符型。
在 Android 中成员变量
非 public 非 static 的变量可以使用 m 开头
非常量的 static 变量可以使用 s 开头
4.5)常量命名
命名规则:类常量的声明,应该全部大写,单词间用下划线隔开。
例如:private static final int UPDATE_VERSION_Setting = 1;
4.6)异常命名
自定义异常的命名必须以 Exception 为结尾。已明确标示为一个异常。
4.7)layout命名
layout.xml 的命名必须以全部单词小写,单词间以下划线分割,并且使用名词或名词词组,即使用 模块名功能名称所属页面类型 来命名。
如:video_controller_player_activity 视频模块下的-控制栏-属于播放器的-Activity页
4.8)id命名
layout 中所使用的 id 必须以全部单词小写,单词间以下划线分割,并且使用名词或名词词组,并且要求能够通过 id 直接理解当前组件要实现的功能。
如:TextView @+id/tv_book_name_show ;
4.9)资源命名
layout 中所使用的所有资源(如 drawable , style 等),命名必须以全部单词小写,单词间以下划线分割,并且尽可能的使用名词或名词组,
即使用 模块名_用途 来命名。如果为公共资源,如分割线等,则直接用用途来命名
如:menu_icon_navigate.png

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值