Android 编程规范指南

浏览数：31 / 时间：2015年06月11日

Requirement：需求文档；

    Design：设计文档；
    Planning&Log：计划、日志、会议；
    Test：集成测试、系统测试、测试报告；
    Study：学习资料、demo等；
    Deployment：发布、部署等；
    Source：源代码以及单元测试；
    Help：相关帮助文档；

2.源码目录规范
    目录即包（package）；目录下所有类都属于这个命名空间，一主类一文件；
    目录层次递归；一般系统命名空间目录最好不要超过3层；

二.代码编码规范

1.常见的命名规范
    pascal命名法（Delphi）：每个单词首字母大写；
    camel命名法（驼峰命名法）：第一个单词首字母小写，后面的单词都大写；
    匈牙利命名法（VB）：用前缀标定特征和属性；如mName;
    下划线命名法：用下划线来分割；如常量；

2.Android命名特点：
    包：全部小写；
    文件命名：文件名即类名；
    类命名：（普通类）pascal命名法；（自定义属性类）加上Attribute；（自定义异常类）加上Exception；（泛型类型传递）K、T；
    方法命名：pascal命名用于构造函数；camel命名用于普通函数；动宾短语；
    接口命名：一般加后缀命名；

变量命名：（类中）私有成员变量（mMyName）、公有变量、静态变量（sMyName）；局部变量（camel）；方法参数（camel）；循环变量（无意义的字母）；

优化：局部变量以_打头，参数变量以p打头；

3.格式化：
严格换行：一个冒号换一行；｛｝各占一行；

严格缩进：使用Tab缩进；重视缩进和代码缩进对齐；

    严格注释：文件，类，方法，方法参数，变量，属性；文件和类一定要包含如下元素：Name，Description，Version，Date,Author,Change,Copyright；
    声明的位置：相似的import放在一起，可以很清晰；成员变量放在最前面，最好不要穿插来放；局部变量也放在局部方法前面；
    使用java预定义类型而不使用类名声明变量；

三、代码逻辑规范

1.避免将多个类放在一个文件里面，除非是一次性使用的内部类；
2.一个方法的代码长度最好不要超过35行；
3.原则上，尽量不要手动修改机器产生的代码；
4.final String代替直接的“String”，同理int；
5.不要在正常循环语句中，进行直接的return操作；
6.不要用goto语句；
7.处处要考虑异常，特别是I/O操作，多进行try...catch操作；
8.仅仅对外公布的才使用public，其他的使用private or internal；
9.尽量不要提供public and protected 程序标量，使用属性代替他们；
10.不要在系统自动生成的函数直接些业务代码，最好自定义函数，然后调用；
11.总是使用借口，推荐使用显示接口实现；
12.在switch语句中总是要有default字句来显示信息；

郑重声明：本站内容如果来自互联网及其他传播媒体，其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享，并不代表本站赞同其观点和对其真实性负责，也不构成任何其他建议。

Android 编程规范指南