移动开发编码规范.docxVIP

文档版本：V1.0 文档编号：TS204 秘级：仅供内部使用 模板版本：V 1.3 本模板最后修订日期：2013-08-29 移动开发编程 移动开发编程规范 Android For QOE 北京直真科技股份有限公司 2013年08月29日 历史记录 版本 编制 审核 批准 更改记录 发布人 日期 审核人 日期 批准人 日期 1.0 陈健平 2013.08.29 何利文、曾波 2013/9/4 —— —— 创建 目录 TOC \o 1-3 \h \z \u 1 阅读对象 4 2 参考文献 4 3 术语和缩写 4 4 引言 7 5 编程规范 7 5.1 命名规范 7 5.1.1 包命名规则 8 5.1.2 类命名规则 8 5.1.3 变量命名规则 9 5.1.4 常量命名规则 9 5.1.5 方法命名规则 10 5.1.6 组件命名规则 10 5.1.7 layout命名规则 11 5.1.8 资源文件命名规则 11 5.1.9 id命名规则 11 5.2 注释约定 11 5.2.1 类注释 14 5.2.2 变量常量注释 14 5.2.3 方法注释 15 5.2.4 Java 注释的三种类型 15 5.2.5 Javadoc的快速浏览 16 5.3 异常处理 17 5.4 日志处理 17 5.5 开发环境版本规范 17 6 成员函数可见性 17 7 Java编程技巧 18 7.1 更好的组织代码 18 7.2 把常量放到比较表达式的左侧 18 7.3 聪明的使用final 19 7.4 最小化公共和保护接口 19 7.5 参数和返回值 19 8 程序设计风格 19 8.1 风格格式 20 8.2 使用空格 20 8.3 限制代码行的长度 20 8.4 给常量一个名字 20 8.5 代码分段/缩进 20 8.6 多行语句的处理 21 8.7 在代码中使用空行 21 8.8 遵循 30 秒条法则 21 8.9 写短小单独的命令行 21 8.10 说明运行顺序 21 9 21种代码的坏味道 22 10 版本控制 24 阅读对象 本文的阅读对象是使用Java作为编程语言的开发人员，主要针对Android开发的一些规则定义。 参考文献 项目的编码规范遵守Android和Java的编码规范。?具体可查看? /source/code-style.html? 公司的《JAVA编程规范.doc》 建议完整阅读完这些文档，其中包含很多有用信息。 术语和缩写 存取函数 修改或者返回字段值的成员函数。也叫访问修改程序。参见获取函数和设置函数。 分析模式 描述一个业务/领域解决方案的建模模式。 反模式 一种解决一般问题的方法，可及时地证明是否错误或无效。 字段 用来描述一个类或者类的实例的数据类型或其它对象的变量。实例字段描述对象（实例），静态字段描述类。字段也被称为字段变量和属性。 BDK Beans 开发工具 (Beans development kit)。 块 包含在大括号内的零个或多个语句的集合。 括号 即字符 { 和 }，分别叫开括号和闭括号，用来定义一个块的开始和结束。 类 创建对象的定义或模板。 类测试 确信一个类及其实例能如所定义的那样工作的行为。 CMVC 配置和版本控制。 编译单元 存在于磁盘上的物理源码文件或是存放在一个数据库中的“虚拟”源码文件，类和接口在其中定义。 组件 象列表、按钮或者窗口那样的接口部件。 构造函数 完成对象创建时任何所需的初始化成员函数。 容器 包含有其它对象的对象，它与其它对象合作来完成自身的行为。这可以通过使用内部类 (JDK 1.1+) 或者一个对象内其它类的实例集合 (JDK 1.0+) 来实现。 C 语言风格的注释 一种 Java 注释语句格式 /* 和 */，取自 C/C++ 语言，它可用于生成多行注释。通常用来“注释掉”测试中不需或者不想要的代码行。 设计模式 描述一个设计问题的解决方案的建模形式。 析构函数 一个用来当一个对象不再需要时从内存中删去该对象的 C++ 类成员函数。因为 Java 管理自身的内存，所以这种函数不需要。但 Java 支持一个功能上类似的叫做 finalize() 的成员函数。 文档注释 一个 Java 注释格式 /** 和 */，可由 javadoc 处理，来给一个类文件提供外部说明。对于接口、类、成员函数和字段的主要说明应用文档注释来写。 字段 参见“属性”。 finalize() 在一个对象从内存里删除