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

1、-程序设计计书记述述标准批准人刘岩审核人崔戈拟制人罗世毅批准日期期19999.5.12生效日期期19999.5.12关联文件设计文档档管理规规程（RR-0550044）设计文档档标准（S-0040001）沈阳东东东系统集集成有限限公司更改记录录序号发行日更改对象象更改内内容批准审查拟制019999.5.12新发行刘岩崔戈罗世毅目录 1. 前言2/9 2. 程序设设计书的的设计思思路2/99 3. 程序设设计书的的构成2/994. 文文档的写写法2/995. 程程序设计计书样例例3/991.前言言程序设计计书是在在程序设设计时，定义程程序的模模块和各各模块的的外部规规范的文文档。换换言之，是规定

2、定程序具具有什么么样的构构成要素素、各构构成要素素占有什什么样的的位置、实现什什么样的的功能的的文档。2.程序序设计书书的设计计思路( 1)以系统统规范书书和系统统设计书书为基准准。( 2)在充分分理解了了该程序序要做什什么的基基础上进进行程序序设计。对于不不明确的的地方，不要随随意地判判断，而而应同系系统设计计者进行行确认。( 3)要明确确地记述述程序是是完成什什么功能能的。( 4)原则上上不写模模块内的的逻辑关关系（算算法/流程等等）。若若对说明明功能有有用时，作为补补充资料料附加上上。( 5)要明确确记述模模块的层层次结构构和模块块接口。( 6)程序设设计书可可模块一一览表、模块说说明书

3、，程序流流程图及及补充资资料构成成。( 7)程序设设计书对对程序制制作来讲讲，是防防止处理理功能遗遗漏及重重复的，并在编编码前明明确接口口及子功功能资料料。( 8)是他人人可对程程序进行行维护的的资料。因此，程序设设计书作作为在看看源程序序清单时时的辅助助资料，要写得得简单、易懂。( 9)不要漏漏写必要要的信息息,也不要要写不必必要的重重复信息息。(10)程序设设计书与与源程序序在一起起是一个个完整的的文档。因此，在在程序设设计书中中不要记记载不必必要的编编码内容容。另外，对对于理解解源程序序有帮助助的信息息要作为为辅助资资料尽量量附加上上。(11)对于异异常处理理功能也也要在充充分研讨讨之后

4、写写上，错错误一览览也可归归纳总结结为另外外的文件件。3.程序序设计书书的构成成程序设设计书必必须包含含封面，修改履履历，目目录，可可根据实实际情况况选择模模块构成成图，模模块构成成表，画画面项目目属性说说明，全全局变量量说明，事件一一览表，Claass关关系图，Claass构构成说明明，Cllasss交互图图，画面面迁移图图等项目目4.文档档的写法法文档格式式若本文文件没有有特别规规定的话话，遵循循公司的的设计计文档管管理规程程（RR-0550044）和设计文文档标准准（SS-0440011）。当当客户指指定标准准时，遵遵循其指指定的标标准。在功能表表示上要要留意以以下几点点：(1)叙叙述要

5、简简明清晰晰。避免使用用含义模模糊或者者涉及范范围很广广的词。(2)不不使用否否定之否否定形态态的句子子。(3)数数据名称称在系统统中要统统一。消息名称称、事件件名称、设备名名称、功功能名称称等。5程序序设计书书样例1.Cllasss关系图图2.Cllasss交互图图3. 画画面项目目属性说说明画面4-7 画面项目说明：4. CClasss构成成说明CBtrrapii是控制BBtriievee文件I/O的类类。画面面中的数数据操作作是用CCbtrrApii类做成成Btrribeeve文文件。类的层次次和相关关类 CCbtrrApii 文件件I/OO类类成员内部变变量m_sPPosBBlocck

6、 BTTRCAALL函函数的位位置块*pCFFileeInffo 指定Bttrieeve文文件信息息类的指指针属性（prootecctedd）构造CBtrrApii *pCCFilleInnfo的的初始化化数据转转换（pprottectted） ChaarTooStrr 记记录从HHex转转换成CCSriingStrTTochhar 记录从从CSrringg转换成成Hexx操作（pubblicc）GetFFirsst 用Btrrievve文件件取得第第一个记记录GetNNextt 用Btrrievve文件件取得当当前记录录后面的的记录Openn 打开指指定的BBtriievee文件Inseer

7、t 用Btrrievve文件件插入新新的记录录Updaata 更新指指定的记记录Deleete 删除指指定的记记录Closse 关闭Bttrieeve文文件5. 函函数一览览序号函数名称称函数描述述com_oraa_Coonneect提供与OOraccle数数据库的的连接com_oraa_diiscoonneect断开与OOraccle数数据库的的连接com_oraa_WrriteeBinn将文件传传送给数数据库表表的二进进制字段段com_oraa_ReeadBBin将数据库库表的二二进制字字段传送送给文件件com_oraa_GeetCoode获取可用用举报编编号或案案件编号号com_oraa

8、_TDD_Neew在业务字字典中插插入一个个新项com_oraa_TDD_Uppgraade对业务字字典进行行版本升升级com_oraa_TDD_Fllg设置业务务字典当当前版本本的有效效标志com_oraa_SeetRoolePPoweer取消/赋赋予角色色权限com_oraa_SeetOpperaatioonPoowerr取消/赋赋予操作作权限com_oraa_SeetFuuncttionnPowwer取消/赋赋予职能能权限com_oraa_SeetEnndCaaseFFlagg设置是否否结案标标志com_oraa_SeetEnndCaaseDDatee设置结案案时间com_oraa_Se

9、etReeferrencceFllag设置参照照标志com_oraa_UppdatteCaaseCCodee修改案件件编号com_oraa_GeetCaavitty获取举报报或案件件的空号号6. 画画面一览览序号窗体名称称窗体描述述FrmAAbouut关于系统统FrmAAceddObjjIn被举报对对象的录录入FrmAAceddObjjOptt举报立案案时选择择被举报报对象FrmAAceddPsoonDeetaiil显示被举举报人的的详细情情报信息息FrmAAceddPsoonViiew被举报人人一览选选择FrmAAnwsserOObjVVieww待答复对对象一览览(助手中中详细按按钮用)Fr

10、mAAssiistaant助手FrmCCaseeAviisoIInfoo案情通报报情报FrmCCaseeAviisoSShoww案情通报报情报FrmCCaseeAviisoVVieww案情通报报情报一一览FrmCCaseeCoddeVaary案件编号号变更FrmCCaseeDeaalCoountt统计中案案件处理理情况FrmCCaseeDeaalSuum案件处理理情况专专项统计计FrmCCaseeInffoViiew一个举报报的立案案情况FrmCComeeUniitOppt转来单位位选择FrmDDisaagreeeUnnitOOpt不同意结结案单位位选择FrmDDispparttInffo指定

11、分级级情报FrmDDisppOptt处理情报报选择FrmDDisppTyppe处理类别别变更、处理类类别选择择、转办办处理确确认FrmEEndRReInnfo结案答复复情报FrmEEndRReShhow结案答复复情报表表示FrmEEndRReViiew结案答复复情报一一览FrmEEnqRReCaaseVVieww询问答复复案件一一览(助手中中详细按按钮用)FrmEEnqRReInnfo询问答复复情报FrmEEnqRReShhow询问答复复情报表表示FrmEEnqRReViiew询问答复复情报一一览FrmFFunddStoore入库情况况FrmGGrannt产品授权权情报登登记FrmHHandd

12、RessulttSumm上报结果果情况专专项统计计FrmIInfooSett情报信息息设定FrmIInfooSettDattaill情报设定定详细FrmIInsppPayyTaxxInffo检查补税税情报一一览FrmIInsppPsoonInnfoVVieww检查人员员情报一一览FrmIInsppPsoonOppt检查人员员选择FrmIInsppReppInffo检查报告告情报FrmIInsppReppShoow检查报告告情报表表示FrmIInsppReppVieew检查报告告情报一一览FrmLLderrPosstill领导批示示情报FrmLLderrPosstillVieew领导批示示情报一

13、一览FrmLLderrSiggnSuum领导批示示情况专专项统计计FrmLLockk系统锁定定FrmLLogIIn系统登录录FrmMMainn本系统的的主画面面FrmMMidRRepIInfoo中间报告告情报FrmMMidRRepSShoww中间报告告情报表表示7.函数数说明函数序号号：155函数名：comm_orra_UUpdaateCCaseeCodde功能说明明： 修改案案件编号号。函数头部部：Publlic Funnctiion comm_orra_UUpdaateCCaseeCodde(ByVaal PP_OLLDCOODE As Strringg, ByVaal PP_NEEWCOODE As Strringg) Ass Loong参数及返返回值：参数名类型I/O说明P_OLLDCOODEStriingI旧的案件件编号P_NEEWCOODEStriingI新的案件件编号返回值Longg0: