软件开发设计规范简述

原创 2004年07月01日 10:34:00

一、      前言<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

1. 设计规范的重要性

整个软件开发过程是个相当复杂的过程,不是单靠几个设计师在那里编写代码就可以.往往在软件开发过程中会有各种没有预料到的情况发生,比如客户需求不断变化,设计人员流失等等,为了保证软件的质量,能够达到客户的满足和满足市场的要求,早期工作做的越是完善,之后产生的返工,成本增加的可能性就越低.对开发和设计进行一定的规范就显得非常有必要了,对于不同的开发人员来说,遵照一定的原则进行编码和命名(比如广泛使用的匈牙利规则),有助于整个软件的开发进度并且对二次开发产生积极的作用.

2. 本设计规范的适用范围

本规范适用于常用可视化软件开发工具,Delphi,VC,VB,.NET,WEB开发语言ASP(VbScript,JavaScript,JScript脚本语言),PHP,JSP,对于不同工具会有一些差别,下面会对部分进行说明.因时间匆忙,表述比较简单,个中作用还得各位在开发中自己取体会。

二、      说明性文件规范

1.规范描述

1)      写在每个程序文件的文件头,说明整个文件的作用

2)      以语言的注释符加---------------------------开始和结尾,Delphi//,ASP

3)      File Name:文件名

4)      Author作者 Version 版本 Date 完成日期

5)      Description:用以描述此程序文件的主要功能,与其他模块和函数的接口,输出值,取值范围,含义以及参数间的控制,顺序,独立或者依赖等关系

6)      Others:其他内容的说明

7)      Function List:主要函数列表,每条记录应包含函数名和简要说明

8)      History:修改历史记录列表,每条记录应包含修改作者,修改日期和修改内容

2.规范实例

    ASP为例

    ‘-------------------------------------------------------------

    ‘File Name:MsgView.asp

    ‘Author:Name  Version:1.0   Date:<?xml:namespace prefix = st1 ns = "urn:schemas-microsoft-com:office:smarttags" />2004/1/29

   ‘Description:View Short Message From Other Friends which is

                   Permitted(Can Be Set in Friends.asp By Admin)

    ‘Others:SQL Injection Denied

    ‘Function List:

       ‘1)IsPermetted(iUsID):Check User has Permission to Send

           Message Or not;

       ‘2)ViewFriend():View All User’s Friend;

    ‘History:

       ‘1)Check Spelical Characters By Jack On 2004/5/2

    ‘-------------------------------------------------------------

三、      过程注释规范

1.规范描述

1)      写在过程的开头,以注释符加----------------------------开始结尾

2)      Description:功能描述

3)      Author 作者 Date 完成日期

4)      Parameters:参数说明

5)      Calls:被本过程调用的函数和过程清单

6)      Called By:调用本过程的函数或过程清单

7)      Table Accessed:被访问的表(仅限涉及数据库操作的程序)

8)      Table Updated:被修改的表(仅限涉及数据库操作的程序)

9)      History:修改历史记录列表,每条记录应包含修改作者,修改内容和修改时间

2.规范实例

    Delphi为例

    /*---------------------------------------------------

    Description:Test NetWorkConnection

    Author:Peter Date:2003/1/11

    Parameters:sIP Char[15](Remote IP Address)

    Calls:None

    Called By:BtnTestConnection_Click()

    Table Accessed:None

    Table Updated:None

    History:None

    ------------------------------------------------------*/

四、      函数注释规范

1.规范描述

1)      写在函数的开头,以注释符加----------------------------开始结尾

2)      Description:功能描述

3)      Author 作者 Date 完成日期

4)      Parameters:参数说明

5)      Return:返回值说明

6)      Calls:被本函数调用的函数和过程清单

7)      Called By:调用本函数的函数或过程清单

8)      Table Accessed:被访问的表(仅限涉及数据库操作的程序)

9)      Table Updated:被修改的表(仅限涉及数据库操作的程序)

10)  History:修改历史记录列表,每条记录应包含修改作者,修改内容和修改时间

2.规范实例

    Delphi为例

    /*---------------------------------------------------

    Description:Get MAC Address From Network Adapter

    Author:Peter Date:2004/2/11

    Parameters:sIP char[15]

    Return:

MAC St
ring

    Calls:None

    Called By:showUserInfo()

    Table Accessed:None

    Table Updated:None

    History:None

    ------------------------------------------------------*/

 

五、      命名规范

1.变量命名的目标


1)      使变量的用途明确

2)      使每个变量的数据类型和可见范围清晰明了

3)      使代码中的过程易于理解

4)      使程序易于调试

5)      使变量的存储和处理更为有效

2.控件的常用命名

普通控件

名称

前缀

示例

button

btn

btnSubmit

calendar

cal

calBirthday

checkBox

chk

chkBlue

checkBoxList

chkl

chklFavColors

DataGrid

dgrd

dgrdTitles

DataList

dlst

dlstTitles

DropDownList

drop

dropBirthYear

Hyperlink

link

linkDetails

Image

img

imgPhoto

ImageButton

iBtn

iBtnSubmit

Label

lbl

lblResult

LinkButton

lBtn

lBtnWebSite

ListBox

lst

lstFriends

Panel

pnl

pnlPersonal

RadioButton

rad

radSex

Textbox

txt

txtIP

Table

tbl

tblMessage

ADO.Net控件

Connection

con

conNorthWind

Command

cmd

cmdReturnPages

Parameter

parm

parmUsID

DataAdapter

dad

dadProducts

DataReader

dtr

dtrProducts

DataSet

dst

dstUser

DataTable

dtbl

dtblProducts

DataRow

drow

drowRow9

DataView

dvw

dvwFilteredUsers

DataColumn

dcol

dcolUserID

DataRelation

drel

drelMasterDetail

 

 

 

3.变量对象的命名

类型

前缀

示例

Char

c

cText

Byte

by

byImage

Boolean

b

bResult

String

s

sIP(VB,ASP)

ColorRef

cr

crFavColor

坐标

cx,cy

 

Double Word

dw

dwSpeed

Integer

i

iYear

Array

a

aTemp

Object

o

oConn

Short Integer

n

nWait

Long

l

lWord

Float

f

fText

 

数据结构在软件编程中的地位

 数据结构是计算机存储、组织数据的方式。数据结构是指相互之间存在一种或多种特定关系的数据元素的集合。数据结构在编程中的重要作用具体表现在:     1、数据结构是一门综合性较强的计算机软件、程...
  • qiuyushuofeng
  • qiuyushuofeng
  • 2015年09月05日 10:53
  • 1315

一些常用的软件开发文档分享给大家

Android 3、最新android ADT-21.1.0 4、Android开发精典案例60个【源码】 5、安卓开发必学书籍(30本合集) 6、Android经典源码全集[简单易懂] 7...
  • hewenya12
  • hewenya12
  • 2015年03月02日 11:30
  • 1060

软件开发阶段及其文档简述

众所周知,软件开发是一个严格的过程,其严格性体现在哪呢?   它体现在软件开发过程中不同阶段的各个文档上,软件开发是一个文档驱动的过程,每一阶段都有不同的文档与其对应。那么软件开发到底分为几个阶段呢...
  • zt15732621796
  • zt15732621796
  • 2015年08月16日 22:00
  • 2926

华为软件编程规范和范例

〔一〕=====[排版] ]=======  〔二〕======[注释]======= 〔三〕=====[标识符命名]======= 〔四〕=====[可读性]====== 〔五〕=====[...
  • minghuiw
  • minghuiw
  • 2014年07月06日 16:03
  • 1947

简述基于软件体系结构的软件开发过程

软件体系结构是具有一定形式的结构化元素,即构件的集合,包括处理构件、数据构件和连接构件。 处理构件负责对数据进行加工; 数据构件是被加工的信息; 连接构件把体系结构的不同部分组组合连接起来。 这一定义...
  • u010970703
  • u010970703
  • 2017年03月04日 16:32
  • 541

SQL Server数据库设计规范

数据库设计规范 1.简介 数据库设计是指对一个给定的应用环境,构造最优的数据库模式,建立数据库及其他应用系统,使之能有效地存储数据,满足各种用户的需求。数据库设计过程中命名规范很是重要,命名规范合...
  • tzstzstzsxy
  • tzstzstzsxy
  • 2016年02月26日 14:00
  • 238

Web应用界面设计规范

目录: 一、软件界面规范的重要性及其目的 二、用户体验为何如此重要 三、Web规范体系介绍 四、界面设计开发流程 五、应该遵循的基本原则 六、界面设计规范 一、软件界面规范的重要性及其目的   ...
  • jerrying0203
  • jerrying0203
  • 2015年05月05日 15:45
  • 2247

Web UI设计规范、设计细节、设计趋势

文字大小的的突破与约束 越来越多的衬线 增加使用手绘设计 gif图片,很好的吸引了用户的注意 真实信息 第一是界面的美观度,第二是界面之间交互设计的合理性和易用性。一目了然的明确想要什么 ...
  • qq_28656345
  • qq_28656345
  • 2017年10月13日 10:28
  • 648

安卓APP设计规范和设计细节

我们在进行安卓APP设计时,需要好好调整之前的设计规范和设计细节。根据目前流行的安卓手机的系统体验来完成我们的安卓APP设计规范。应该说这是整理出最全面的安卓app设计规范。 1、安卓app设计规范之...
  • qq_22260761
  • qq_22260761
  • 2016年03月08日 17:46
  • 448

安卓app设计规范整理和Android APP设计篇

转载地址:http://www.25xt.com/appdesign/6536.html 随着安卓智能手机不停的更新换代。安卓手机系统越来越完美,屏幕尺寸也越来越大啦!比如最近小米的...
  • l_215851356
  • l_215851356
  • 2016年08月31日 14:44
  • 1811
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:软件开发设计规范简述
举报原因:
原因补充:

(最多只允许输入30个字)