程序设计书记述标准.DOC

-  程序设计书 记述标准 批准人 刘岩 审核人 崔戈 拟制人 罗世毅 批准日期 1999.5.12 生效日期 1999.5.12 关 联 文 件 设计文档管理规程（R-05004） 设计文档标准（S-04001） 沈阳东东系统集成有限公司  更改记录 序号 发行日 更改对象·更改内容 批准 审查 拟制 0 1999.5.12 新发行 刘岩 崔戈 罗世毅 目 录 1. 前言 2/9 2. 程序设计书的设计思路 2/9 3. 程序设计书的构成 2/9 4. 文档的写法 2/9 5. 程序设计书样例 3/9 1.前言 程序设计书是在程序设计时，定义程序的模块和各模块的外部规范的文档。换言之，是规定程序具有什么样的构成要素、各构成要素占有什么样的位置、实现什么样的功能的文档。 2.程序设计书的设计思路 ( 1)以系统规范书和系统设计书为基准。 ( 2)在充分理解了该程序要做什么的基础上进行程序设计。对于不明确的地方，不要随意地判断，而应同系统设计者进行确认。 ( 3)要明确地记述程序是完成什么功能的。 ( 4)原则上不写模块内的逻辑关系（算法/流程等）。若对说明功能有用时，作为补充资料附加上。 ( 5)要明确记述模块的层次结构和模块接口。 ( 6)程序设计书可模块一览表、模块说明书，程序流程图及补充资料构成。 ( 7)程序设计书对程序制作来讲，是防止处理功能遗漏及重复的，并在编码前明确接口及子功能资料。 ( 8)是他人可对程序进行维护的资料。因此，程序设计书作为在看源程序清单时的辅助资料，要写得简单、易懂。 ( 9)不要漏写必要的信息,也不要写不必要的重复信息。 (10)程序设计书与源程序在一起是一个完整的文档。 因此，在程序设计书中不要记载不必要的编码内容。 另外，对于理解源程序有帮助的信息要作为辅助资料尽量附加上。 (11)对于异常处理功能也要在充分研讨之后写上，错误一览也可归纳总结为另外的文件。 3.程序设计书的构成 程序设计书必须包含封面，修改履历，目录，可根据实际情况选择模块构成图，模块构成表，画面项目属性说明，全局变量说明，事件一览表，Class关系图，Class构成说明，Class交互图，画面迁移图等项目． 4.文档的写法 文档格式若本文件没有特别规定的话，遵循公司的《设计文档管理规程》（R-05004）和《设计文档标准》（S-04001）。当客户指定标准时，遵循其指定的标准。 在功能表示上要留意以下几点： (1)叙述要简明清晰。 避免使用含义模糊或者涉及范围很广的词。 (2)不使用否定之否定形态的句子。 (3)数据名称在系统中要统一。 消息名称、事件名称、设备名称、功能名称等。 5．程序设计书样例 1.Class关系图 2.Class交互图 3. 画面项目属性说明 4. Class构成说明 CBtrapi 是控制Btrieve文件I/O的类。画面中的数据操作是用CbtrApi类做成Btribeve文件。 类的层次和相关类 CbtrApi 文件I/O类 类成员 □ 内部变量 m_sPosBlock BTRCALL函数的位置块 *pCFileInfo 指定Btrieve文件信息类的指针 □ 属性（protected） □ 构造 CBtrApi *pCFileInfo的初始化 □ 数据转换（protected） CharToStr 记录从Hex转换成CSring StrTochar 记录从CSring转换成Hex □ 操作（public） GetFirst 用Btrieve文件取得第一个记录 GetNext 用Btrieve文件取得当前记录后面的记录 Open 打开指定的Btrieve文件 Insert 用Btrieve文件插入新的记录 Updata 更新指定的记录 Delete 删除指定的记录 Close 关闭Btrieve文件 5. 函数一览 序号 函数名称 函数描述 com_ora_Connect 提供与Oracle数据库的连接