Android项目开发中编码风格规范总结

一、目录规范，要有readme.txt文件

项目名：驾校一路通

项目介绍：

Requirement - 需求相关文档
Design - 设计
Planning&Log - 计划，日志，会议
Test - 集成测试，系统测试，测试报告，Buglist
Study - 学习资料，Demo等
Deployment - 发布，部署
src - 源代码及单元测试

我项目中文件的结构如下：

二、包名规范，一般不超过三层，全部小写

组织名.项目名.包功能名

文件命名：Pascal命名法

三、代码规范

命名空间的命名规则：
同类的分一组排列

注释：
文件，类，方法，方法参数，变量，属性都要注释
文件和类的注释一定要包含如下元素：Name，Description，Version，Date，Author，Change，Copyright
遵循JavaDoc标准
变量注释：上面用双斜杠，单行注释，不要放在代码同行后面

成员变量的命名：
私有成员变量：前缀m/s + Pascal命名
private String mMyName;
公有成员变量：Camel命名

静态成员变量：
static String sMyName；
局部变量：前缀加下划线
方法参数中，前缀加p

方法的命名：
动宾短语
Pascal命名用于构造函数，Camel命名用于普通函数

接口的命名：

我们的编码约定：逻辑规范

避免将多个类放在一个文件里面，除非是一次性使用的内部类
一个方法的代码长度不要超过35行
原则上，尽量不要手工的修改机器产生的代码
Final String取代直接“Stirng”，同理int
不推荐在循环语句中，进行直接的return操作
不要用goto
处处要考虑异常，并且要有finally处理
仅对需要对外公布才用public，其余的用private or internal
尽量不要提供public and protected程序变量，使用属性代替他们
不要在系统自动生成函数直接写业务代码，最好自定义函数，然后调用
总是使用接口，推荐使用显示接口实现
在switch语句中总是要有default自居来显示信息

附：常见四种命名法

Pascal命名法：每个单词首字母大写 --》一般用在文件命名

Camel命名法：第一个单词首字母小写，以后每个单词首字母大写 --》变量

匈牙利命名法：前头加类型首字母 + Pascal命名法， --》 属性的私有成员变量定义，静态成员变量的定义，前头加s

下划线命名法：每个单词用下划线隔开 --》一般用在数据库中