Android菜鸟的成长笔记——编码规范什么的

一、系统目录

Requirement、Design、Planning、Help、Log、Source、Publish、Test（Requirement 需求相关文档；design 设计；Planning&Log 计划、日志、会议；Test 集成测试、系统测试、测试报告；study学习资料，Demo等；deployment 发布部署；src,Sourse源代码及单元测试）。

二、源代码目录规范

1、目录即包；

2、一主类一文件；

3、目录层次递归；

4、一般系统命名空间目录尽量不要超过3层。

三、命名方法

1、Pascal命名法：每个单词的首字母大写；

2、Camel：变量首个单词的字母小写，其余大写；

3、匈牙利命名法：用一个前缀标定一个变量；

4、下划线命名法：单词与单词之间用下划线隔开。

四、命名规则

1、常量用大写加下划线的方式；

2、文件命名Pascal；

3、类的命名：普通类Pascal，自定义属性类Pascal，后缀使用Attribute，异常类Pascal，后缀加Exception；

4、泛型中的类型传递，大写字母（K，T）等；

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

6、接口的命名：事件接口定义后缀加Listener；

7、变量命名：私有成员变量，m+Pascal，静态成员变量s+Pascal，局部变量camel，方法参数camel，循环中的变量，首字母缩写。

五、命名格式

1、严格换行一个  ‘ ；‘一换行；

2、函数{}分别占一行；严格缩进；

3、严格注释，文件，类，方法，方法参数，变量，属性都要注释，文件和类的注释一定要包含如下元素：Name，Description，Version，Date，Author，change，Copyright要符合JavaDoc标准。

六、  类成员变量的声明位置

1、 所有成员变量都应该声明在顶部，同时使用一空行来将他们和属性以及方法分开；

2、 局部变量的声明放到方法的顶部。

七、编码逻辑规范

1、  避免将多个类放到一个文件里面，除非是一次性使用的类；

2、  一个方法的代码长度最好不要超过35行；

3、  原则上，尽量不要手工修改机器产生的代码；

4、  Final String取代“string”，同理用常量取代数字；

5、  不推荐在循环语句中进行直接的Return操作；

6、  不要用goto；处处考虑异常；

7、  仅对需要对外公布才用public，其余的private or internal；

8、  尽量不要提供public andprotected程序员变量，用属性代替它们；

9、  不要在系统自动生成的函数直接写业务代码，最好自定义函数然后调用，总是使用接口，推荐使用显示接口实现；

10、         在switch语句中总是要有default字句来显示信息。

八、可参考规则

局部变量可以使用下划线开头，方法参数可以以p开头。

九、声明的位置：

将所有的框架定义的命名空间为一组，自定义的和第三方的命名空间放在另一组。

十、Java Doc标记

javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成，javadoc 标记有如下一些：

1、 @author 标明开发该类模块的作者

2、 @version 标明该类模块的版本

3、 @see 参考转向，也就是相关主题

4、 @param 对方法中某参数的说明

5、 @return 对方法返回值的说明

6、 @exception 对方法可能抛出的异常进行说明