Android 代码规范

xinwu.hu 贡献于2014-03-04

作者 huxinwu  创建于2014-02-28 02:05:00   修改者huxinwu  修改于2014-03-04 02:24:00字数2703

文档摘要:Android代码规范一,代码规范的必要性编码规范对于程序员而言尤为重要,有以下几个原因:1:一个软件的生命周期中,80%的花费在于维护。2:几乎没有任何软件,在其整个生命周期中,均由最初的开发人员来维护。3:编码规范可以改善软件可读性,可以让程序员尽快而彻底地理解新的代码。
关键词:

Android代码规范 作者 时间 版本 备注 Devin.hu 2014-02-28 1.0 目录 一, 代码规范的必要性 2 二, 命名 2 (一) 包命名 2 (二) 类和接口命名 2 (三) 方法命名 3 (四) 变量命名 3 (五) 成员变量命名 4 (六) 常量命名 4 (七) 异常命名 4 (八) layout命名 4 (九) id命名 4 (十) 资源命名 5 一, 代码规范的必要性 编码规范对于程序员而言尤为重要,有以下几个原因: l 1:一个软件的生命周期中,80%的花费在于维护。 l 2:几乎没有任何软件,在其整个生命周期中,均由最初的开发人员来维护。 l 3:编码规范可以改善软件可读性,可以让程序员尽快而彻底地理解新的代码。 l 4:如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品。 二, 命名 (一) 包命名 包命名规则:一个唯一包名的前缀总是全部小写的 ASCII 字母并且是一个顶级域名,通常是 com,edu,gov,mil,net,org。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门 (department) ,项目(project),机器(machine),或注册名(login names)。 例如: com.mudi.nmgbst.* 规约:包命名必须以 com.launch 开始,后面跟有项目名称(或者缩写),再后面为模块名或层级名称。 例如:com. mudi.项目缩写.模块名 com. mudi.idag.api, 例如:com. mudi.项目缩写.层级名 com. mudi.pro.model。 (二) 类和接口命名 命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像 URL,HTML),接口一般要使用 able、ible、er 等后缀。 例如: class BaseActivity; class ApiClient。 规约:类名必须使用驼峰规则,即首字母必须大写,如果为词组,则每个单词的首字母也必须要大写,类名必须使用名词,或名词词组。要求类名简单,不允许出现无意义的单词(如 class XXXActivity)。 例如:class UserHomeActivity à 正确。 例如:class HomeActivityUserà 错误! 应为 class UserHomeActivity (三) 方法命名 命名规则:方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。 例如: public void run(); public String getBookName(); 类中常用方法的命名: 1) 类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上 get,如getFirstName(),getLastName()。一般来说,get 前缀方法返回的是单个值,find 前缀的方法返回的是列表值。 2) 类的设置方法(一般返回类型为 void):被访问字段名的前面加上前缀 set,如setFirstName(),setLastName()。 3) 类的布尔型的判断方法一般要求方法名使用单词 is或has 做前缀,如isNetWorkConnected(),isString()。或者使用具有逻辑意义的单词。 例如 equal 或 equals。 4) 类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用动词,首字母小写,如 openFile(),addCount()。 5) 构造方法应该用递增的方式写。(参数多的写在后面)。 6) toString()方法:一般情况下,每个Model类都应该定义 toString()。 (四) 变量命名 命名规则:第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为 i,j,k,m 和 n,它们一般用于整型;c,d,e,它们一般用于字符型。 例如:String bookName。 规约:变量命名也必须使用驼峰规则,但是首字母必须小写,变量名尽可能的使用名词或名词词组。同样要求简单易懂,不允许出现无意义的单词。 例如:String bookNameà 正确。 例如:String bookNameString;à错误。 (五) 成员变量命名 同变量命名规则相似,而且在成员私有变量前加m,这只是本公司的编码习惯而已,但是不建议加m。 (六) 常量命名 命名规则:类常量的声明,应该全部大写,单词间用下划线隔开。 例如:static final int DATA_LOAD_ING = 0x01, 例如:static final int DATA_LOAD_COMPLETE = 0x02, 例如:static final int DATA_LOAD_FAIL = 0x03。 (七) 异常命名 自定义异常的命名必须以 Exception 为结尾。已明确标示为一个异常。 例如:AppException。 (八) layout命名 规约:layout xml 的命名必须以全部单词小写,单词间以下划线分割,并且使用名词或名词词组,建议使用模块名_功能名称来命名。Layout开头为公共模块的布局资源。其他模块均匀模块名称为前缀。 例如:activity_app_start.xmlà正确。 例如:about_activity.xml 或 about_layout.xmlà正确(推荐)。 (九) id命名 规约:layout 中所使用的 id 必须以控件缩写为前缀,加名词或名词词组,单词间以下划线分割,并且要求能够通过 id 直接理解当前组件要实现的功能。在Activity中的控件名称直接使用这个,方便查找。 例如:某TextView @+id/aboutmail à错误 例如:@+id/tv_about_mail 。正确 (十) 资源命名 规约:layout 中所使用的所有资源(如drawable, style等)命名必须以全部单词小写,单词间以下划线分割,并且尽可能的使用名词或名词组,即使用模块名_用途来命名。如果为公共资源,如分割线等,则直接用用途来命名。 例如:action_search.png à 正确。 例如:分割线:line.png 或 separator.png à正确。 Drawable的几种状态 Ø 例如:正常状态:btn_add.png Ø 例如:点击状态:btn_add_press.png Ø 例如:不可用状态:btn_add_unenable.png Ø 例如:selector:selector_btn_add.png

下载文档到电脑,查找使用更方便

文档的实际排版效果,会与网站的显示效果略有不同!!

需要 5 金币 [ 分享文档获得金币 ] 1 人已下载

下载文档