家校通概要设计说明书Word文件下载.docx

家校通概要设计说明书Word文件下载.docx

《家校通概要设计说明书Word文件下载.docx》由会员分享，可在线阅读，更多相关《家校通概要设计说明书Word文件下载.docx（35页珍藏版）》请在冰豆网上搜索。

3临时表

4视图

2.3.1.2表命名定义：

AB_+表的英文名称

a）.A表示表的性质，

‘无’代表用户表（与业务处理直接相关的表）

S代表系统表（为完成业务而建的对用户非透明的表）

b）.B表示表的类型，

C码表（包含唯一代码，一次性生成，很少改动）

D数据存放表（业务数据、控制、设置、记录系统信息等）

T临时表（程序动态生成）

V视图

c）.表的英文名称表示表的英文名称，可缩写；

d）.举例

用户码表：

c_bank

系统码表：

sc_user

2.3.2编程规范

2.3.2.1对象命名规范

对象类型

序号

项目

前缀

备注

1

复选框

Cbx

CheckBox

2

命令按钮

Cb

CommandButton

3

数据窗口

Dw

DataWindow

4

下拉列表框

Ddlb

DropDownListBox

5

带图标下拉列表框

Ddplb

DropDonwPictureListBox

6

带格式编辑框

Em

EdistMask

7

函数

F

Function

8

函数对象

Fo

Function_Object

9

图表

Gr

Graph

10

分组框

Gb

GroupBox

11

水平滚动条

Hsb

HScrollBar

12

线

Ln

Line

13

列表框

Lb

ListBox

14

列表视图

Lv

ListView

15

菜单

M

Menu

16

多行编辑器

Mle

MultiLineEdit

17

对象公用函数

OF

ObjectFunction

18

OLE控件

Ole

OLE

19

椭圆

Oval

20

图片

Pic

Picture

21

图形按钮

Pb

PictureButton

22

带图标列表框

Plb

PictureListBox

23

无线按钮

Rb

RadioButton

24

矩形

R

Rectangle

25

超文本编辑器

Rte

RichTextEdit

26

圆角矩形

Rr

RoundRectangle

27

对象私有函数

SF

SystemFunction

28

单行编辑器

Sle

SingleLineEdit

29

静态文本

St

StaticText

30

标签

Tab

31

树状视图

Tv

TreeView

32

用户对象

Uo

UserObject

33

垂直滚动条

Vb

VscrllBar

34

窗口

W

Window

35

管道

Pipe

PipeLine

36

工程

P

Project

37

代理

Pro

Proxy

2.3.2.1.1PBL对象命名

（类+）对象类型前缀+‘_’+对象英文名

如：

uo_process_render

cw_process_ancestor

2.3.2.1.2控件对象命名

对象类型前缀+‘_’+对象英文名

pic_background

sle_password

2.3.2.2变量命名规范

变量类别

全局变量

G

Global

共享变量

S

Shared

实例变量

I

Instant

局部变量

L

Local

远端变量

Remote

2.3.2.2.1数据变量类型

任意类型

A

Any

大数据

Blob

布尔型

B

Boolean

字符型

C

Char,Character

日期型

D

Date

时间型

T

Time

日期时间型

DT

DateTime

小数型

Dec

Dec,Decimal

双精度型

DB

Double

整型

Int,Integer

长整型

Long

实型

Real

字符串型

String

无符号整型

UI

Uint,UnsignedInt,UnsignedInteger

无符号长整型

UL

Ulong,UnsignedLong

2.3.2.2.2对象变量类型

应用

App

Application

HscrollBar

连接

Connection

上下文信息

Ctinfo

ContextInformation

上下文关键字

CtKeyword

ContextKeyword

数据存储

Ds

DataStore

动态描述区

Ddsa

DynamicDescriptionArea

38

动态存储区

Dsa

DynamicStagingArea

39

错误

Err

Error

40

Internet

Inet

41

Internet结果

InetResult

InternetResult

42

邮件会晤层

Mailsession

43

消息

Msg

Message

44

OLE对象

OleObject

OLEOject

45

OLE存储

OleStorage

46

OLE流

OleStream

47

48

PB对象

Pbo

PowerObject

49

剖面

Profiling

50

服务

Service

51

定时器

Timing

52

轨迹树

TraceTree

53

事务

Trans

Transaction

54

传输

Transport

2.3.2.2.3变量命名

变量类别+数据类型变量/对象类型变量+‘_’+变量英文名

gs_username

lpic_background

2.3.3注释书写规定

2.3.3.1PBL

a）.PBL注释

PBL库的注释必须标明该库的类别及其功能。

格式：

库类别（10个汉字，不足用‘-’补齐）+功能。

如：

公用库--------------公用函数

业务逻辑-----------汇缴处理

用户界面-----------归集查询分析

b）.PBL内对象注释

PBL内对象的注释应标明该对象所属的业务、作者及其功能。

格式：

所属业务（10个汉字，不足用‘-’补齐）+作者名（3个汉字，不足用‘-’补齐）+‘--’+功能描述

公用函数------------惠兴海--以给定分隔符合并字符串

汇缴处理------------喻兵-----汇缴用户界面，处理正常汇缴业务

2.3.3.2Script注释

a）.注释符号

‘//’

不许使用’/**/’作注释符。

b）.函数注释

每个函数都应描述该函数的名称、功能、作用范围、入口参数的类型和传值方式及参数含义、返回值类型及返回值的含义。

格式：

//

//Function:

函数名

//Purpose:

用途

//Scope:

作用范围

//Args:

入口参数（列表）类型传值方式含义

//Returns:

返回值类型（可确定值列表）含义

c）.非函数注释

注明该模块的作用

//

//功能

d）.程序行间注释

在程序行的每一个处理单元前作注释。

//注释

e）.注释举例

F_FindObject

按照控件名在可视化主对象中查找主对象内的可视化控件。

Public

//Arguments:

ls_nameStringValue将要查找的控件名

//lpbo_objectPowerObjectValue可视化主对象

//lpbo_findPowerObjectRef存放并返回查找到的控件,返回NULL则表

//示可视化主对象内无控件或可视化主对象不能包含

//控件

BooleanTrue表示找到该控件

//False表示未找到该控件

Integerli_loop,li_total

Windowlw_object

UserObjectluo_object

Stringls_control_name

Objectlo_type

li_loop=1

//取得lpbo_object的类型

lo_type=lpbo_object.TypeOf（）

//根据lpbo_object的类型分别处理

ChooseCaselo_type

CaseWindow!

//Window类型

lw_object=lpbo_object

li_total=UpperBound（lw_object.control[]）

Ifli_total<

1Then

SetNull（lpbo_find）

ReturnFalse

EndIf

//查找

DoWhileli_loop<

=li_total

ls_control_name=lw_object.control[li_loop].ClassName（）

Ifls_control_name=ls_nameThen

lpbo_find=lw_object.control[li_loop]

ReturnTrue

EndIf

li_loop++

Loop

SetNull（lpbo_find）

ReturnFalse

CaseUserObject!

//UserObject类型

luo_object=lpbo_object

IfNOTluo_object.objecttype=CustomVisual!

Then

//可视UserObject类型

li_total=UpperBound（luo_object.control[]）

ls_control_name=luo_object.control[li_loop].ClassName（）

lpbo_find=luo_object.control[li_loop]

EndChoose

//非Window和UserObject类型

SetNull（lpbo_find）

ReturnFalse

2.3.3.3Script书写规范

2.3.3.3.1大小写

a）.大写

以下项目必须用大写书写：

1）.SQL关键字，如：

INSERT、SELECT、USING等

2）.逻辑运算符，如：

NOT、AND、OR等

b）.小写

以下项目必须用小写书写：

1）.各种对象名

2）.各种对象的属性

3）.各种变量

4）.数据表拥有者名称，如：

dba

5）.数据表名

6）.字段名

c）.匈牙利书写法

以下项目必须用匈牙利书写法书写：

1）.用于定义变量的对象类型，如CW_Process_Ancestor

2）.枚举值，如：

KeyF1!

Question!

WriteMode!

3）.除逻辑运算符之外的所有PB关键字

4）.函数名称（包括系统函数、用户函数、外部函数和存储过程）

2.3.3.3.2局部变量声明的位置

局部变量的声明必须写在该模块中所有可执行代码之前（游标定义除外）。

2.3.3.3.3缩进

按照程序处理的层次关系逐级缩进。

缩进符：

[Tab]键。

不许用空格键缩进。

2.3.3.3.4间隔

1）.在定义变量时应在声明类型和变量之间用[Tab]键分隔，使每一项声明的第一个变量尽可能的垂直对齐。

2）.在数学运算符、逻辑运算符的前后两端必须各以一个空格与其两边的部分分隔。

2.3.3.3.5换行

每一条语句占一行或多行，不许在一行中书写一条以上的语句（即在一行上不能有用’;

’分开的两条或两条以上的语句）。

2.3.3.3.6分节

根据程序处理中不同的阶段用空行对各个阶段分节（至少一个空行，最多可有两个连续的空行）。

2.3.3.3.7SQL书写规范

a）.分行

每个SQL关键字或短语应占一行，关键字和其后的字段、变量、条件表达式等应以[Tab]键分隔，尽量使关键字后的字段、变量、条件表达式等的第一项垂直对齐。

b）.顺序

1）.操作子句后的字段排列应与字段在数据库中的物理顺序一致

2）.WHERE子句后的条件表达式的排列顺序应与FROM子句中的表的排列顺序相对应，条件表达式中的字段出现顺序应与字段在数据库中的物理顺序一致，但是若条件表达式中的字段存在索引，则条件表达式中的字段出现顺序应与字段在索引中的排列顺序一致

3.软件系统结构设计

3.1复审数据流、控制流

复审需求分析阶段对软件的功能需求的描述（如系统的DFD图和IDEF0图）是否合理和精化。

否则，应在本节进行进一步分解和精化。

3.2软件体系结构

3.2.1软件程序结构图

3.2.2模块命名规则

3.2.2.1功能编号定义：

FXXYY00

a）.F1位，代表功能（FUNCTION）；

b）.XX2位，代表子系统编号；

c）.YY2位，代表子系统下的一级模块编号；

d）.002位，代表二级及二级以下模块的流水编号；

3.2.2.2功能命名定义：

操作+‘_’+操作对象名称如Edit_Person

a）.操作代表实施某一动作，如Edit、Adjust、Query等；

b）.操作对象名称代表操作对象，如Person、Rate、Render等；

该位可选；

3.2.3模块描述

3.2.3.1学校微网站

3.2.3.1.1学校简介：

对学校简介和机构进行管理

名称

文件、通知、规范、规定的网上收发

标识

F0101

子系统名称

办公管理

系统

名称

系统（OA）

接　口

说　明

输入

文件、通知、规范、规定等的信息

输出

功　能

通过网上收发文件、通知、规范、规定等。

运行环

境说明

用LotesNotes实现。

调用关

系说明

调用模块

被调用模块

文件、通知、规范、规定的接收、发送

3.2.3.1.2信息公告：

学校通知、公告、新闻的展示

电子邮件的收发

F0102

邮件收发信息

通过Notes实现电子邮件的收发功能。

电子邮件的接收、发送

3.2.3.2用户管理

3.2.3.2.1组织机构管理：

将所有组织机构统一管理起来，实现学校、班级机构的属性管理，能够通过统一的界面方便的创建、修改、冻结（毕业班级）组织机构

文件资料分类登记

F0201

文件资料库管理

文件资料基本信息

登记文件资料的基本信息，其中级别可分为：

国家、省、市、本公司、各部门和分公司、其他，类别可分为：

行政制度、质量、安全、其他等。

3.2.3.2.2文件资料分类查询

文件资料分类查询

F0202

查询条件

文件资料库信息

通过查询条件，检索各种文件资料信息，并提供浏览功能。

3.2.3.2.3用户管理

文件资料维护

F0203

文件资料修改信息

通过查询，检索文件资料信息，进行修改维护。

3.2.3.2