软件编码规范详述(98页)详解.docVIP

软件编码规范 文件状态： [] 草稿 [ ] 正式发布 [ ] 正在修改 文件编号： RDC-DED-SCS-SPC-00 当前版本： 作 者： 完成日期： 中国人民银行清算总中心支付系统开发中心文档修订记录 版本编号 变化状态 简要说明 日期 变更人 批准日期 批准人 注：变化状态：A—增加，M—修改，D—删除  目 录 第一篇 C/C++编码规范 6 第一章 代码组织 6 第二章 命名 9 2.1 文件命名 9 2.2 变量命名 9 2.3 常量与宏命名 10 2.4 类命名 10 2.5 函数命名 10 2.6 参数命名 11 第三章 注释 12 3.1 文档化注释 12 3.2 语句块注释 17 3.3 代码维护注释 20 第四章 编码风格 22 4.1 排版风格 22 4.2 头文件 26 4.3 宏定义 27 4.4 变量与常量 30 4.5 条件判断 32 4.6 空间申请与释放 33 4.7 函数编写 33 4.8 类的编写 37 4.9 异常处理 40 4.10 特殊限制 40 第五章 编译 41 第六章 ESQL/C编码 46 第二篇 Java编码规范 47 第一章 代码组织 48 第二章 命名 51 2.1 包命名 51 2.2 类命名 51 2.3 接口命名 51 2.4 方法命名 51 2.5 变量命名 51 2.6 类变量命名 52 2.7 常量命名 52 2.8 参数命名 52 第三章 注释 53 3.1 文档化注释 53 3.2 语句块注释 57 3.3 代码维护注释 59 第四章 编码风格 61 4.1 排版风格 61 4.2 包与类引用 66 4.3 变量与常量 66 4.4 类编写 67 4.5 方法编写 68 4.6 异常处理 71 4.7 特殊限制 71 第五章 编译 73 第六章 JSP编码 74 6.1 文件命名及存放位置 74 6.2 内容组织 74 6.3 编码风格 76 6.4 注释 78 6.5 缩进与对齐 78 6.6 表达式 79 6.7 JavaScript 79 第三篇 PowerBuilder编码规范 80 第一章 代码组织 81 第二章 命名 82 2.1 文件命名 82 2.2 对象命名 82 2.3 变量命名 84 2.4 常量命名 85 2.5 函数与事件命名 85 2.6 参数命名 85 第三章 注释 85 3.1 文档化注释 85 3.2 语句块注释 88 3.3 代码维护注释 88 第四章 编码风格 89 4.1 界面风格 89 4.2 排版风格 93 4.3 变量与常量 95 4.4 条件判断 96 4.5 空间申请与释放 97 4.6 函数编写 97 4.7 特殊限制 97 第五章 SQL编码 98 前 言 程序编码是一种艺术，既灵活又严谨，充满了创造性与奇思妙想。然而应用软件设计一工程个人艺术大型软件项目由大型开发团队协同统一编程规范程序可读性较差不仅给代码理解带来障碍增加维护阶段的工作量不规范的隐含错误。 复杂应用应分子系统创建目录结构，模块程序代码应分别放置到src/module/include目录与src/module/source目录，应用编译文件放置到src目录，编译后的可执行文件放置到rel/bin目录，静态库或动态库放置到rel/lib目录。（应用使用的外部库及头文件放置在rel同级的lib与lib/include目录） 各子系统可以创建独立的编译文件并放置到src/module/source目录，编译后的可执行文件放置到rel/bin/module目录或rel/bin，静态库或动态库放置到rel/lib/module或rel/lib目录。此时，应创建一个编译全部子系统的编译文件或脚本放置到src目录。 命名 命名应遵循下列原则： 应简单清晰通俗； 应使用英文命名，禁止使用中文命名； 应尽量选择通用词汇； 应使用完整单词或词组，避免使用简称； 应准确表达其含义； 避免同时使用易混淆的字母与数字，如1与l，0与o； 禁止使用只靠Count of Failure（FailCnt），Paging Request（PagReq）。 文件命名 文件命名应使用模块名的小写字母形式。禁止使用汉字或大、小写字母混用作为代码文件名。 变量命名 变量命名主要采用匈牙利命名法，格式为[作用域范围前缀_][前缀]基本类型＋名称。其中，作用域范围前缀、前缀以小写字母表示且可选，基本类型以小写字母表示且必选。 常用前缀符 前缀符 含义 例子 g_ 全局变量 g_stSystem, g_cMacType， g_strSysName s_ 静态变量 s_nCurC