某公司程序设计书记述标准分析

1、最新 精品 Word 欢迎下载 可修改-程序设计书记述标准 批准人刘岩审核人崔戈拟制人罗世毅批准日期1999.5.12生效日期1999.5.12关联文件设计文档管理规程（R-05004）设计文档标准（S-04001）沈阳东东系统集成有限公司更改记录序号发行日更改对象更改内容批准审查拟制01999.5.12新发行刘岩崔戈罗世毅目 录 1. 前言2/9 2. 程序设计书的设计思路2/9 3. 程序设计书的构成2/9 4. 文档的写法2/9 5. 程序设计书样例3/9 1.前言 程序设计书是在程序设计时，定义程序的模块和各模块的外部规范的文档。换言之，是规定程序具有什么样的构成要素、各构成要素占有什

2、么样的位置、实现什么样的功能的文档。2.程序设计书的设计思路( 1)以系统规范书和系统设计书为基准。( 2)在充分理解了该程序要做什么的基础上进行程序设计。对于不明确的地方，不要随意地判断，而应同系统设计者进行确认。( 3)要明确地记述程序是完成什么功能的。( 4)原则上不写模块内的逻辑关系（算法/流程等）。若对说明功能有用时，作为补充资料附加上。( 5)要明确记述模块的层次结构和模块接口。( 6)程序设计书可模块一览表、模块说明书，程序流程图及补充资料构成。( 7)程序设计书对程序制作来讲，是防止处理功能遗漏及重复的，并在编码前明确接口及子功能资料。( 8)是他人可对程序进行维护的资料。因此

3、，程序设计书作为在看源程序清单时的辅助资料，要写得简单、易懂。( 9)不要漏写必要的信息,也不要写不必要的重复信息。(10)程序设计书与源程序在一起是一个完整的文档。 因此，在程序设计书中不要记载不必要的编码内容。 另外，对于理解源程序有帮助的信息要作为辅助资料尽量附加上。(11)对于异常处理功能也要在充分研讨之后写上，错误一览也可归纳总结为另外的文件。3.程序设计书的构成程序设计书必须包含封面，修改履历，目录，可根据实际情况选择模块构成图，模块构成表，画面项目属性说明，全局变量说明，事件一览表，Class关系图，Class构成说明，Class交互图，画面迁移图等项目4.文档的写法 文档格式若

4、本文件没有特别规定的话，遵循公司的设计文档管理规程（R-05004）和设计文档标准（S-04001）。当客户指定标准时，遵循其指定的标准。 在功能表示上要留意以下几点：(1)叙述要简明清晰。 避免使用含义模糊或者涉及范围很广的词。(2)不使用否定之否定形态的句子。(3)数据名称在系统中要统一。 消息名称、事件名称、设备名称、功能名称等。5程序设计书样例1.Class关系图2.Class交互图 3. 画面项目属性说明 画面4-7 画面项目说明：4. Class构成说明CBtrapi 是控制Btrieve文件I/O的类。画面中的数据操作是用CbtrApi类做成Btribeve文件。类的层次和相关类

5、 CbtrApi 文件I/O类类成员 内部变量 m_sPosBlock BTRCALL函数的位置块 *pC 指定Btrieve文件信息类的指针 属性（protected） 构造 CBtrApi *pC的初始化 数据转换（protected） CharToStr 记录从Hex转换成CSring StrTochar 记录从CSring转换成Hex 操作（public）GetFirst 用Btrieve文件取得第一个记录GetNext 用Btrieve文件取得当前记录后面的记录Open 打开指定的Btrieve文件Insert 用Btrieve文件插入新的记录Updata 更新指定的记录Delete

6、 删除指定的记录Close 关闭Btrieve文件5. 函数一览序号函数名称函数描述01.com_ora_Connect提供与Oracle数据库的连接02.com_ora_disconnect断开与Oracle数据库的连接03.com_ora_WriteBin将文件传送给数据库表的二进制字段04.com_ora_ReadBin将数据库表的二进制字段传送给文件05.com_ora_GetCode获取可用举报编号或案件编号06.com_ora_TD_New在业务字典中插入一个新项07.com_ora_TD_Upgrade对业务字典进行版本升级08.com_ora_TD_Flg设置业务字典当前版本的

7、有效标志09.com_ora_SetRolePower取消/赋予角色权限10.com_ora_SetOperationPower取消/赋予操作权限11.com_ora_SetFunctionPower取消/赋予职能权限12.com_ora_SetEndCaseFlag设置是否结案标志13.com_ora_SetEndCaseDate设置结案时间14.com_ora_SetReferenceFlag设置参照标志15.com_ora_UpdateCaseCode修改案件编号16.com_ora_GetCavity获取举报或案件的空号6. 画面一览序号窗体名称窗体描述01.FrmAbout关于系统0

8、2.FrmAcedObjIn被举报对象的录入03.FrmAcedObjOpt举报立案时选择被举报对象04.FrmAcedPsonDetail显示被举报人的详细情报信息05.FrmAcedPsonView被举报人一览选择06.FrmAnwserObjView待答复对象一览(助手中详细按钮用)07.FrmAssistant助手08.FrmCaseAvisoInfo案情通报情报09.FrmCaseAvisoShow案情通报情报10.FrmCaseAvisoView案情通报情报一览11.FrmCaseCodeVary案件编号变更12.FrmCaseDealCount统计中案件处理情况13.FrmCas

9、eDealSum案件处理情况专项统计14.FrmCaseInfoView一个举报的立案情况15.FrmComeUnitOpt转来单位选择16.FrmDisagreeUnitOpt不同意结案单位选择17.FrmDispartInfo指定分级情报18.FrmDispOpt处理情报选择19.FrmDispType处理类别变更、处理类别选择、转办处理确认20.FrmEndReInfo结案答复情报21.FrmEndReShow结案答复情报表示22.FrmEndReView结案答复情报一览23.FrmEnqReCaseView询问答复案件一览(助手中详细按钮用)24.FrmEnqReInfo询问答复情报2

10、5.FrmEnqReShow询问答复情报表示26.FrmEnqReView询问答复情报一览27.FrmFundStore入库情况28.FrmGrant产品授权情报登记29.FrmHandResultSum上报结果情况专项统计30.FrmInfoSet情报信息设定31.FrmInfoSetDatail情报设定详细32.FrmInspPayTaxInfo检查补税情报一览33.FrmInspPsonInfoView检查人员情报一览34.FrmInspPsonOpt检查人员选择35.FrmInspRepInfo检查报告情报36.FrmInspRepShow检查报告情报表示37.FrmInspRepVi

11、ew检查报告情报一览38.FrmLderPostil领导批示情报39.FrmLderPostilView领导批示情报一览40.FrmLderSignSum领导批示情况专项统计41.FrmLock系统锁定42.FrmLogIn系统登录43.FrmMain本系统的主画面44.FrmMidRepInfo中间报告情报45.FrmMidRepShow中间报告情报表示7.函数说明(1) 函数序号：15(2) 函数名：com_ora_UpdateCaseCode(3) 功能说明： 修改案件编号。 (4) 函数头部： Public Function com_ora_UpdateCaseCode(ByVal P_OLDCODE As String, ByVal P_NEWCODE As String ) As Long(5) 参数及返回值：参数名类型I/O说明P_OLDCODEStringI旧的案件编号P_NEWCODEStringI新的案件编号返回值Long 0: