公司程序设计书记述标准分析模板.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-7 — 画面项目说明：
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. 函数一览

序号
函数名称
函数描述
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_TDNew
在业务字典中插入一个新项
07.
com_ora_TD_Upgrade
对业务字典进行版本升级
08.
com_ora_TD_Flg
设置业务字典目前版本有效标志
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
相关系统
02.
FrmAcedObjIn
被举报对象录入
03.
FrmAcedObjOpt
举报立案时选择被举报对象
04.
FrmAcedPsonDetail
显示被举报人具体情报信息
05.
FrmAcedPsonView
被举报人一览选择
06.
FrmAnwserObjView
待回复对象一览(助手中具体按钮用)
07.
FrmAssistant
助手
08.
FrmCaseAvisoInfo
案情通报情报
09.
FrmCaseAvisoShow
案情通报情报
10.
FrmCaseAvisoView
案情通报情报一览
11.
FrmCaseCodeVary
案件编号变更
12.
FrmCaseDealCount
统计中案件处理情况
13.
FrmCaseDealSum
案件处理情况专题统计
14.
FrmCaseInfoView
一个举报立案情况
15.
FrmComeUnitOpt
转来单位选择
16.
FrmDisagreeUnitOpt
不一样意结案单位选择
17.
FrmDispartInfo
指定分级情报
18.
FrmDispOpt
处理情报选择
19.
FrmDispType
处理类别变更、处理类别选择、转办处理确定
20.
FrmEndReInfo
结案回复情报
21.
FrmEndReShow
结案回复情报表示
22.
FrmEndReView
结案回复情报一览
23.
FrmEnqReCaseView
问询回复案件一览(助手中具体按钮用)
24.
FrmEnqReInfo
问询回复情报
25.
FrmEnqReShow
问询回复情报表示
26.
FrmEnqReView
问询回复情报一览
27.
FrmFundStore
入库情况
28.
FrmGrant
产品授权情报登记
29.
FrmHandResultSum
上报结果情况专题统计
30.
FrmInfoSet
情报信息设定
31.
FrmInfoSetDatail
情报设定具体
32.
FrmInspPayTaxInfo
检验补税情报一览
33.
FrmInspPsonInfoView
检验人员情报一览
34.
FrmInspPsonOpt
检验人员选择
35.
FrmInspRepInfo
检验汇报情报
36.
FrmInspRepShow
检验汇报情报表示
37.
FrmInspRepView
检验汇报情报一览
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_OLDCODE
String
I
旧案件编号
P_NEWCODE
String
I
新案件编号
返回值
Long

0: 成功
-1: 失败
1010: 旧案件编号长度不是 10 位
1020: 新案件编号长度不是 10 位
1030: 存在于受理举报立案中
1040: 存在于转办举报立案中
1050: 存在于反复举报立案中
1060: 未查找到旧案件编号

(6) 参考数据库表：
表EXPOSURECASEINDEX
表REPEATEXPOSURECASE

(7) 调用子函数：无

(8) 补充说明：