-
程序设计书记述标准
批准人
刘岩
审核人
崔戈
生效日期
拟制人
罗世毅
批准日期
1999.5.12
1999.5.12
设计文档管理
规程(
R-05004
)
设计文档
标准(
S-04001
< br>)
关
联
文
件
沈阳东东系统集成有限公司
更改记录
序号
发行日
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)
原则上不写模块内的逻辑关系
(
算法
/
流程等
)
。若对说明功能有用时,作为补充
< br>
资料附
加上。
( 5)
要明确记述模块的层次结构和模块接口。
( 6)
程序设计书可模块一览表、模块说明书,程序流程图
及补充资料构成。
( 7)
程序设计书对程序制作来讲,
是防止处理功能遗漏及重复的,
并在编码前明确接
口及子
功能资料。
( 8)
是他人可对程序进行维护的资料。
因此,程序设计书作为在看源程序清单时的辅
助资
料,要写得简单、易懂。
( 9)
不要漏写必要的信息
,
也不要写不必要的重复信息。
<
/p>
(10)
程序设计书与源程序在一起是一个完整的文档。
因此,在程序设计书中不要记载不必要的
编码
内容。
另外,对于理解源程序有帮助的信息要作为辅助资料尽
量附加上。
(11)
对于异常处理功
能也要在充分研讨之后写上,错误一览也可归纳总结为另外的
文件。
3.
程序设计书的构成
程序设计书必须包含封面,修改履历,目录,可根据实际情况选择模块构成图,模
块构成表,
画面项目属性说明,全局变量说明,事件一览
表,
Class
关系图,
Class
构成
说明,
Class
交互图,画面迁移图等项目
.
4.
文档的写法
文档格式若本文件没有特别规定的话,
遵循公司的《设计文档管理规程》
(
R-05004
)
和《设计
文档标准》
(
S-04001
)
。当客户指定标
准时,遵循其指定的标准。
在功能表示上要留意以下几点:
(1)
叙述要简明清晰。
避免使用含义模糊或者涉及范围很广的词。
(2)
不使用否定之否定形态的句子。
(3)
数据名称在系统中要统一。
消息名称、事件名称、设备名称、功能名称等。
5
?程序设计书样例
关系图
环
isitC
CIIKT
或舐
3
饥
EntAfth
询
打
V i sitC uiKT
eteEhtn
■归
(
th
询
0
交互图
□理
nmr
C
□
m
m
日
「
id hl
已
ch
日
「
I
?nn
flfindiDg :
;
I
□匚
ommand
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
I
H
1
1
i
1
5: DMributa N?ttflution
r
;
4:
Distribute
Notification :
[I
1
i
1
广
1
i
1
1
1
?
6; Abort ihe
^perdtion
--------------------------------------
-----------------------
I
il
7 Di^rnhiiliP
ARH1R T N^tilih^iti^irk
;
i
a
i
□
T
i
4
1
■
-
-
-
-
-
-
-
-
-
上一篇:镀涂符号
下一篇:德语动词过去时-original