程序设计书记述标准.docxVIP

程序设计书记述标准 批准人 刘岩 审核人 崔戈 拟制人 罗世毅 批准日期 1999.5.12 生效日期 1999.5.12 关 联 文 件 设计文档管理规程（R-05004） 设计文档标准（S-04001） 沈阳东东系统集成有限公司 更改记录 序号 发行日 更改对象?更改内容 批准 审查 拟制 0 1999.5.12 新发行 刘岩 崔戈 罗世毅 目录 前言 2../.9. 程序设计书的设计思路 2../9 程序设计书的构成 2../.9 文档的写法 2../.9 程序设计书样例 3../.9 前言 程序设计书是在程序设计时， 定义程序的模块和各模块的外部规范的文档。 换言之， 是规定程序具有什么样的构成要素、各构成要素占有什么样的位置、实现什么样的功能 的文档。 程序设计书的设计思路 ( 1) 以系统规范书和系统设计书为基准。 ( 2) 在充分理解了该程序要做什么的基础上进行程序设计。 对于不明确的地方， 不要 随意地判断，而应同系统设计者进行确认。 ( 3) 要明确地记述程序是完成什么功能的。 ( 4) 原则上不写模块内的逻辑关系(算法 / 流程等)。若对说明功能有用时，作为补充 资料附加上。 ( 5) 要明确记述模块的层次结构和模块接口。 ( 6) 程序设计书可模块一览表、模块说明书，程序流程图及补充资料构成。 ( 7) 程序设计书对程序制作来讲， 是防止处理功能遗漏及重复的， 并在编码前明确接 口及子功能资料。 ( 8) 是他人可对程序进行维护的资料。 因此，程序设计书作为在看源程序清单时的辅 助资料，要写得简单、易懂。 ( 9) 不要漏写必要的信息 , 也不要写不必要的重复信息。 (10)程序设计书与源程序在一起是一个完整的文档。 因此，在程序设计书中不要记载不必要的编码内容。 另外，对于理解源程序有帮助的信息要作为辅助资料尽量附加上。 (11)对于异常处理功能也要在充分研讨之后写上，错误一览也可归纳总结为另外的 文件。 3.程序设计书的构成 程序设计书必须包含封面，修改履历，目录，可根据实际情况选择模块构成图，模 块构成表，画面项目属性说明，全局变量说明，事件一览表， Class关系图，Class构成 说明，Class交互图，画面迁移图等项目. 4.文档的写法 文档格式若本文件没有特别规定的话， 遵循公司的《设计文档管理规程》(R-05004) 和《设计文档标准》(S-04001)。当客户指定标准时，遵循其指定的标准。 在功能表示上要留意以下几点： 叙述要简明清晰。 避免使用含义模糊或者涉及范围很广的词。 不使用否定之否定形态的句子。 数据名称在系统中要统一。 消息名称、事件名称、设备名称、功能名称等。 5 ?程序设计书样例 I.Class关系图 V i sitC uiKT eteEhtn ■归（th询 0 环 isitC ciikt 或舐3饥 EntAfth询 打 2.Class交互图 C□ mm 日「id hl已ch日「I￡nn ;I□匚ommand □理nmr \flfindiDg : FIQQEUiy~OrvnE『 Sql Einaiine!:FIQQuErvEnqinE cation BistiibLitx ;GIQNotify 1: bitirta Commjnid ■ i i i 2: Piass Command To Engine 3: Pre Notify Stat^ Chung@ ； i i I a i ；4: Distribute Notification : H 1 1 5: DMributa N?ttflution i r 1 广 6; Abort ihe ^perdtion 7 Di^rnhiiliP ARH1R T N^tilih^iti^irk 画面项目属性说明 画面4-7 — 画面项目说明: 序号 画面项目 属性 处理说明 1 助手启用 检查框 选择该项时启动系统后，将自动呼出助手画面。缺省为选择。 2 检查框 缺省状态为选择。 3 系统自动保护 检查框 选择后，若系统在指定的时间内无任何操作（菜单选择，按 钮选择、数据输入） ，系统将被锁定。 4 时间指定 加减框 启用系统自动保护功能时，该项目为可执行状态。点按上下 按钮可以加减编辑框中的数值，该数值可以直接输入，缺省 为15分钟。范围： 0-120。 5 系统工作年份 检查框 指定系统工作年份后，举报编号和案件编号将根据此处设定 的年份生成。缺省为不指定。 6 年份 加减框 指定系统工作年份时，该项目为可执行状态。点按上下按钮 可增减年份，亦可直接输入。范围： 1900-9999 。 7 要求结案时间 检查框 指定要求结案时间后，在新建举报立案情报时，输入举报收 到时间后，要求结案时间会被自动表示。缺省为：指定。