《软件编码风格规范》.doc

计算机源代码编写规范 GEO-QT-00-733 修改章节 修改内容 版本号 编写/修改 审阅 批准 所有 新发布 0 王琳 王密 朱欣焰 B0版审批记录： 目 录 1. 目的 1 2. 适用范围 1 3. 读者对象 1 4. 基本编码风格指导 1 4.1. 标识符命名及书写 1 4.1.1. 标识符的命名 1 4.1.2. 源代码文件标识符命名 2 4.2. 注释及格式要求 2 4.2.1. 源代码文件的注释 2 4.2.2. 函数或过程的注释 2 4.2.3. 语句的注释 3 4.2.4. 常量和变量的注释 3 4.2.5. 控制结构的缩进 3 4.2.6. 缩进的限制 3 4.3. 数据说明 4 4.4. 语句结构 4 4.5. 代码编写要求 4 4.5.1. 基本要求 4 4.5.2. 可读性要求 5 4.5.3. 结构化要求 5 4.5.4. 正确性与容错性要求 5 4.5.5. 可重用性要求 6 5. VC编码规范 6 5.1. 命名 6 5.1.1. 变量名、宏 6 5.1.2. 局部变量（或自动变量） 6 5.1.3. 全局变量 6 5.1.4. 类成员变量（或类数据成员） 6 5.1.5. 函数变量 6 5.1.6. 宏 6 5.2. 枚举定义风格 7 5.3. 输出动态库约定 7 5.4. 常用数据类型约定符 7 5.4.1. 字符、字符串 7 5.4.2. 整型 8 5.4.3. 浮点数 8 5.4.4. 不定类型指针 8 5.4.5. 布尔型、字节型 9 5.4.6. 句柄 （32bits） 9 5.4.7. Windows 结构变量 9 5.4.8. Windows MFC库中定义的独立对象结构和集合类 10 5.5. GeoStar类实例变量（对象）定义 11 5.6. 6.6.函数名 11 5.6.1. 全局函数名 11 5.6.2. 一般函数 11 5.7. 类定义风格 12 5.8. 接口定义风格 12 5.9. Windows中几个常用宏 12 5.10. IDL参数的定义 12 6. Dephi编码规范 12 6.1. 源程序书写规范 12 6.1.1. 通用源代码格式规则 12 . 缩进 12 . 边距 13 . begin...end 语句 13 . 注释 13 6.1.2. Object Pascal语句格式语句书写规范与用法 13 . 括号 13 . 保留字和关键字 13 . 过程和函数 14 . 变量 15 . 类型 15 . 语句 16 . 结构化异常处理 17 6.2. 命名规范 18 6.2.1. 过程(Procedure)与函数(Function) 18 . 命名 18 . 形参 18 . 命名冲突 18 6.2.2. 常量（Constants）和变量(Variable) 18 . 常量 18 . 变量 18 6.2.3. 类型(Type) 19 . 一般类型 19 . 类型(Class) 19 . 元件类型 21 . 窗体与对话框类型 23 . 数据模块类型 25 6.2.4. 文件 25 . 窗体文件 25 . 数据模块文件 25 . 远程数据模块文件 25 . 单元文件 25 6.3. 源程序文档注释规范 27 6.3.1. 注释文档的一般规范 28 . 注释位置 28 . 注释块 28 . 忽略文档注释 28 6.3.2. 单元文件注释文档格式 29 6.3.3. 函数（属性）的注释文档格式 29 6.4. Delphi代码自动格式化工具 30 7. Java编码规范 30 7.1. 编码规范 30 7.1.1. 格式 30 . 缩进 30 . 间隔 31 . 空行 32 . 类成员的摆放顺序 32 . 文件格式 32 . 行最大长度 33 . 括号 33 . 标识符 33 . 类和接口 33 0. 包 33 1. 其它标识符 33 2. get和set方法 33 3. 注释 33 4. JavaDoc 34 5. 代码的自我说明 36 7.1.2. 编码 37 . 决不要使用的结构 37 . 初始化 38 . 作用域（scope） 38 7.2. 编码规则 38 7.2.1. 类型与变量命名规则 38 7.2.2. 创建类的规则 39 7.2.3. 单元测试 39 7.2.4. 类方法设计 39 7.2.5. 类设计 39 7.2.6. 尽量私有化 39 7.2.7. 使用内部类 40 7.2.8. 文档注释 40 7.2.9. 使用常数定义 40 7.2.10. 类创建处理 40 7.2.11. 类清除处理 40 7.2.12. 使用数组传参 41 7.2.13. 抽象类与接口的选择 41 7.2.14. 源文件保存 41