Andriod开发编码规范.docx

Android开发编码规范目 录1概述42命名方法42.1 标识符命名法42.2 命名原则42.3 英文缩写原则42.4 单词缩写原则53命名规范53.1 包（packages）53.2 类（classes）63.3 接口（interface）63.4 方法（methods）63.5 变量（variables）73.6 常量（Constants）83.7 资源文件（图片drawable文件夹下）83.8 资源布局文件(XML文件(layout布局文件))93.9 动画文件(anim文件夹下)93.10 资源ID（resourcesid）93.11 layout中的id命名103.12 activity中的view变量命名124注释124.1 文件注释124.2 类注释124.3 方法注释124.4 类成员变量和常量注释134.5 其他注释134.6 XML注释135代码风格135.1 缩进135.2 空行135.3 行宽146规约146.1 方法146.2 参数和返回值146.3 神秘的数146.4 控制语句146.5 异常的捕捉处理156.6 访问控制157约定俗成157.1 变量赋值157.2 圆括号167.3 返回值167.4 条件运算符?前的表达式16821种代码的坏味道178.1 Duplicated Code178.2 Long method178.3 Large Class178.4 Divergent Change178.5 Shotgun Surgery178.6 Feature Envy178.7 Data Clumps178.8 Primitive Obsession178.9 Switch Statement178.10 Parallel Inheritance Hierarchies178.11 Lazy Class188.12 Speculative Generality188.13 Temporary Field188.14 Message Chain188.15 Middle Man188.16 Inappropriate Intimacy188.17 Alternative Classes with Different Interfaces188.18 Incomplete Library Class188.19 Data Class188.20 Refused Bequest188.21 Comments199Android编码规范建议19概述为了提高代码的可读性以及更好的团队分工合作，便于在日后的代码审查和修改过程中减少浪费时间，因此制定本编码规范，统一编码风格。命名方法标识符命名法标识符命名法最要有四种:驼峰(Camel)命名法:又称小驼峰命名法，除首单词外，其余所有单词的第一个字母大写。帕斯卡(pascal)命名法:又称大驼峰命名法，所有单词的第一个字母大写下划线命名法:单词与单词间用下划线做间隔。匈牙利命名法:广泛应用于微软编程环境中，在以Pascal命名法的变量前附加小写序列说明该变量的类型。 量的取名方式为：scope_ + prefix_ + qualifier范围前缀，类型前缀，限定词。命名原则尽可能的用最少的字符而又能完整的表达标识符的含义，便于自己或者团队容易记、理解、使用。英文缩写原则较短的单词可通过去掉“元音”形成缩写较长的单词可取单词的头几个字母形成缩写此外还有一些约定成俗的英文单词缩写。下面为常见的英文单词缩写:名称缩写icon ?ic?（主要用在app的图标）color ?cl（主要用于颜色值）dividerdi（主要用于分隔线，不仅包括Listview中的divider，还包括普通布局中的线）selectorsl（主要用于某一view多种状态，不仅包括Listview中的selector，还包括按钮的selector）averageavgbackground??Bg（主要用于布局和子布局的背景）bufferbufcontrolctrldeletedeldocument?docerrorerrescapeescincrementincinfomationinfoinitial?initimageimgInternationalizationI18Nlengthlenlibrarylibmessagemsgpassword-pwdpositionposserversrvstringstrtemptmpwindowwnd(win)单词缩写原则不要用缩写，除非该缩写是约定俗成的。命名规范包（packages）采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xx（采用公司顶级域名），三级包名根据应用进行命名，四级包名为模块名或层级名。包名此包中包