【Android学习】Android编码规范

四种常见的命名法

比较Java和c#的命名规范的不同点

常量用大写

java方法首字母不大写，应该小写

函数行数限制

不要用拼音

参照物，Android源码

看源码工具，SourceInsight 和 Beyond Compare

import中同类的放在一起

Android 文档通过java.doc 实现

私有程序变量命名最前面加m

目录规范

系统目录规范，项目一级文档

• Deployment
• Requirement （需求相关的文档）
• Designn
• Planning
• Help
• Log
• Source
• Publish
• Test

源代码命名规范

• 目录即包（package）
• 目录下所有类都属于此命名空间：一主类一文件
• 目录层次递归
• 一般系统命名空间目录尽量不要超过3层

代码命名规范

命名方法

• 匈牙利命名法：strMyName，mMyName，int intMyName 用一个前缀来标志一些东西，常用于VB6

• Pascal命名法：每个单词的首字母大写 MyName

• Camel命名法：驼峰命名法 首字母小写，其他的首字母大写 java变量命名 myName

• 下划线命名法：s_MyName，m_Name

私有成员变量 Pascal命名＋前缀m
静态成员变量 Pascal命名＋前缀s，在方法中则不加s
局部变量 Camel命名法，或者用下划线开头加Pascal方法
方法参数 Camel命名法，前缀用p
循环中的变量 可以用无意义的字母

注释：文件，类，方法，方法参数，变量，属性都要注释
文件和类的注释一定要包含如下元素：Name，Descrition，Version，Date，Author，Change，Copyright
遵循JavaDoc标准

编码逻辑规范

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