软件部项目管理-项目开发规范-代码编写要求

软件部项目管理-项目开发规范-代码编写要求内容摘要：

.............................................................................. 17 一般目的单元 ...................................................................................................... 17 构件单元 ............................................................................................................... 17 窗体和数据模板 .......................................................................................................................... 17 窗体 .................................................................................................................................... 17 窗体类型命名标准 .............................................................................................. 17 窗体实例命名标准 .............................................................................................. 17 自动创建窗体 ...................................................................................................... 18 模式窗体实例化函数 ......................................................................................... 18 数据模板 ........................................................................................................................... 19 数据模板命名标准 .............................................................................................. 19 数据模板实例命名标准 ..................................................................................... 19 包 .................................................................................................................................................... 19 使用运行包和设计包的比较 ........................................................................................ 19 文件命名标准 .................................................................................................................. 19 构件 ............................................................................................................................................... 20 用户自定义构件 .............................................................................................................. 20 构件单元 ........................................................................................................................... 20 使用注册单元 .................................................................................................................. 20 构件实例命名约定 ......................................................................................................... 20 构件的前缀 ....................................................................................................................... 20 6 C++代码编写标准 .................................................................................................................................... 22 7 Java代码编写标准 .................................................................................................................................. 22 版权所有 169。 Octant Communications Co. Ltd. 保留所有权利。 第 6 页 共 22 页 软件部项目管理 项目开发规范 :代码编写要求 项目开发规范 :代码编写要求 1 引言 编写目的 软件开发的产品质量水平，是一个由来已久的话题。 而提高软件企业的产品质量水平，必须改进软件产品的开发过程。 为此，制定了本规范用于指导软件部的项目开发过程，从而提高达到提高产品质量的目的。 本规范以 Rational Unified Process（简称 RUP） 软件工程过程为蓝本，结合部门的实际情况而选择修改，从而使之适应当前应用级系统设计开发的需要。 本文档主要对程序开发人员的代码编写要求做了详细的规定，以使得整个 开发小组所编写的代码保持一致的风格。 本文档提供给软件部全体成员参考。 背景 软件部在基本完成了成都智能交通信息中心系统之后发现，我们需要一套软件开发规范来指导项目组的开发过程，使得项目开发过程具有可重复性，为此启动了该项目――软件部项目管理。 项目的名称： 软件部项目管理（ Software department Project Management，简称 SPM） 任务提出者： 傲腾通信科技（上海）有限公司软件部 任务开发者： 傲腾通信科技（上海）有限公司软件部 产品使用地： 上海 产品使用者： 傲腾通信科技（上海）有限公司软件部 定义 术语 缩略表示 英文全称 解释说明 软件部项目管理 SPM Octant Software department Project Management 傲腾通信科技（上海）有限公司软件部为了规范项目开发流程而启动的一个项目 项目开发规范 PDS Project Development Specifications 傲腾通信科技（上海）有限公司软件部定义的一种文档类别 参考资料 文档编号 文档名称 作者 版本 来源（存放地） Delphi 4 Code Chinese Borland Inc. C++编程指南 Rational Inc. 2020 Java 编程指南 Rational Inc. 2020 2 安装盘的创建 软件部开发完成的所有系统都使用 Installshield Express。 为了保证快捷方式创建的一致性，现做如下规定，要求快捷方式都创建在： [Start]\[Programs]\Octant Communications\项目名称 版权所有 169。 Octant Communications Co. Ltd. 保留所有权利。 第 7 页 共 22 页 软件部项目管理 项目开发规范 :代码编写要求 3 注册表的使用 为了统一注册 表的使用方式，现做如下规定，要求注册表信息都存放在： HKEY_LOCAL_MACHINE\SOFTWARE\Octant Communications\ProjectName\ModuleName 4 简单加密算法 对于保密性要求不是很高的场合下，我们可以采用简单加密算法 逐位异或算法，具体算法如下： 第一个字符同自己异或作为密文的第一个字节，第二个字符同密文的第一个字节异或作为密文的第二个字节，第三个字符统密文的第二个字节异或作为密文的第三个字节，依次类推 ……；解密算法和加密算法完全一致。 例子 ： 原始字串： CDITS（ 43 44 49 54 53） 加密过程： 43 XOR 43=43 44 XOR 43=07 49 XOR 07=4E 54 XOR 4E=1A 53 XOR 1A=49 密文： 43 07 4E 1A 49 5 Delphi 代码编写标准 通用源代码格式规则 缩格 缩格是指在每一级有两个空格。 不要在源代码中保留 tab 字符，这是因为 tab 字符会随着不同用户的不同设置和不同的资源管理工具（打印、文档、版本控制等）而代表不同的宽度。 你可以通过关闭 Environment选项对话框中 Editor页上的“ Use tab character”和“ Optimal fill”检查框（通过 Tools|Environment）来禁止保存 tab字符。 页边空格 页边空格会被设置成 80 字符宽。 通常，源码不会超出这个边界，但这个方针会有一些弹性。 不管是否有可能，那些超出到另一行的语句会在一个逗号或其他操作符之后与前面的语句相连。 当一个语句被打断相连时，它应比原来的那一行语句缩进两个字符。 Begin… End 配对 Begin 子句应写在独立的一行。 例如，下面第一行是错误的写法而 第二行是正确的。 for I := 0 to 10 do begin //错误， begin同 for在同一行 for I := 0 to 10 do //正确， begin出现在独立的一行 begin 这个规则的例外是当 begin子句的出现是作为一个 else子句的一部分－参考例子： if some statement then 版权所有 169。 Octant Communications Co. Ltd. 保留所有权利。 第 8 页 共 22 页 软件部项目管理 项目开发规范 :代码编写要求 begin … end else begin someOtherStatement。 end。 end 语句永远出现在独立的一行。 当 begin语句不是一个 else子句的一部分时，相应 的 end语句永远缩进到与 begin部分相对应的位置。 注释规范 文件注释 {********************************************************} { 版权所有 (C) 2020,2020 傲腾通讯 } {********************************************************} {******************************************************** 项目 ： 模块 ： 描述 ： 版本 ： 日期 ： 作者 ： 更新 ： ********************************************************} 函数注释 {******************************************************** 功能说明： 输入参数： 输出参数： 返回值： 日期 ： 作者 ： 更新 ： *******************************************************。