软件标准规范Word格式.docx
《软件标准规范Word格式.docx》由会员分享，可在线阅读，更多相关《软件标准规范Word格式.docx（25页珍藏版）》请在冰豆网上搜索。
可以公用的模块或程序。
本规范在以下的各小节中具体说明Delphi两种文件类型.PAS和.DFM在程序文件中的相关内容要求。
2.2常量定义
内容：
逻辑值的定义；
常数值的定义；
错误码的定义；
格式：
一个定义占一行。
如下：
Const<
常量>
:
类型=值;
//注释
说明：
使用Const语句来声明用于代替文字值的常数。
示例：
ConstC_SQL:
string='
selectCH_USERER_IDfromT_CD_USER'
;
//查询用户ID
ConstC_PI:
real=3.1415926;
//圆周率
2.3结构类型定义
结构类型定义
Type
<
类型名>
//结构说明注释
<
变量名1>
变量类型;
//变量说明注释
变量名2>
…
End;
说明：
是以大写字母开头的字符串。
结构定义中定义变量类型的语句从第二行第五列开始。
type
TableList=record//系统树单元类型定义
InID:
integer;
//单元编号
Name:
string;
//单元名称
PID:
//上一级单元名称
PT:
PTableList;
//指向下一单元类型的指针
end;
3程序风格
程序风格规定了每个语句的定位规则及程序中的注释。
3.1函数（Function）/过程（Procedure）风格
Function/Procedure>
Name（变量:
变量类型[,…]）;
//函数/过程说明
Var
变量1：
变量类型；
//变量说明
变量2：
Begin
语句;
……
End;
注：
变量声明、语句均从第三列写起，如有缩进，每次缩进两列，并与相对应语句对齐。
3.2语句风格
在程序体中通常最多每十行有一个段落功能说明；
规范使用各种语句；
语句中有缩进是以二列为单位。
3.2.1变量定义语句
Var
var_name：
<
数据类型>
；
3.2.2赋值语句
var_name:
=<
表达式>
3.2.3条件语句
If条件Then//注释
End
ElseIf条件Then//注释
...
End
Else//注释
注：
如果执行语句只有一句，可省略Begin、End语句。
3.2.4循环语句
//循环功能注释
Forcounter:
=startToendDo
[语句];
End;
While[condition]Do
Repeat
Until[condition]
3.2.5开关语句
//开关功能说明
Case<
表达示>
Of
值1>
:
[语句1];
值2>
[语句2];
…
值n>
[语句n]
End；
3.3注释行
在程序代码单元文件顶端必须拥有本单元文件“模块说明”及“单元说明”注释。
对于常量、结构类型、函数/过程、自定义变量、代码段功能块、关键语句等有含义的代码部分，必须有注释行进行详细说明。
注释行可在需说明部分行后以“//XXXXXXXX”方式添加，也可在需说明部分行上以“{XXXXXXXXXX}”方式添加多行或以“//XXXXXX”方式添加一行。
4变量名命名规则
命名包括对程序中文件、变量（包括控件等对象）、常量、过程和函数等程序对象的命名。
命名以匈牙利规则为参考，采用“限制+类型+名称”的命名方式。
限制是指变量与常量的区分和对作用域的确定，默认为变量和局部对象。
对于常量要特别指出，对于非局部变量，要表明其使用范围，如全局或模块级。
类型以缩写表明该程序对象的类型，如32位有符号整数类型和列表框控件类型。
名称为对象的具体含义，要准确表达其用途，而不要使用与变量所代表的实体没有任何联系的名字，以英文、英文缩写组合给出；
名称的书写采用大小写结合的方式，如CaseCount表示事件计数、DeleteUser表示删除人员等。
命名不宜过短，也不宜过长，除去限制和类型外，以8～15为好。
过短的命名往往不能准确描述用意，如nCount命名含义太不明确，可以是雇员的计数，也可以是找到的文件的计数，而命名为nEmployeeCount和nFileCount将更有助于记忆和理解；
过长的命名如recLoginUserInformation又显得冗长，改为recLoginUserInfor或recLoginUserInfo则会在不损失含义的情况下减少输入量，换言之，改动后的命名更合适。
命名中恰当使用反意词，可以提高可读性，下面是一些常用的容易理解的词对：
Add/Remove
Begin/End
Create/Destroy
Insert/Delete
First/Last
Get/Release
Get/Set
Get/Put
Increment/Decrement
Lock/Unlock
Min/Max
Next/Previous
Next/Prior
Old/New
Open/Close
Show/Hide
Source/Destination
Source/Target
Start/Stop
Write/Read
记住一些常见布尔型变量的命名，对规范化的实施也会有不少帮助，如Done、Error、Found、Success、Ready等
命名中的特例之一是单层循环的循环变量，使用i、j、k、l、m命名，简捷明快；
当循环为多层时，各层的循环变量应尽可能命以有意义的名称，以避免使用时由于输入而产生的逻辑错误，尤其是在访问多维数组变量时，这种作法可以大大减少因数组下标指定失误引发的程序逻辑失败的机率，如将Cells[i,j]误作Cells[j,i]，而Cells[nRow,nCol]就不易误为Cells[nCol,nRow]。
以下定义Delphi中的变量命名规则：
4.1.1简单变量命名
类型
缩写
含义
Boolean
b
Boolean变量
ByteBool
bb
BooleanByte变量
WordBool
bw
BooleanWord变量
LongBool
bl
BooleanLong变量
Integer
n
Number变量
ShortInt
nt
NumberTiny变量
SmallInt
ns
NumberShort变量
LongInt
nl
NumberLong变量
Int64
ne
NumberExtended变量
Comp
Byte
unt
UnsignedNumberTiny变量
Word
uns
UnsignedNumberShort变量
LongWord
unl
UnsignedNumberLong变量
Real
f
Float变量
Single
fs
FloatSingle变量
Double
fd
FloatDouble变量
Extended
fe
FloatExtended变量
Char
c
Char变量
AnsiChar
ca
CharAnsi变量
WideChar
cw
CharWide变量
String
s
String变量
ShortString
ss
StringShort变量
AnsiString
sa
StringAnsi变量
WideString
sw
StringWide变量
Variant
v
Variant变量
Enumerate
e
Enumerate变量
Pointer
p
Pointer变量
4.1.2结构型变量命名
Array
a
Set
m
Mass
Record
r
Class
o
Object
4.1.3复合变量命名
命名中有些缩写词是基础类型缩写，而另有一些是类型限定词，如u代表Unsigned和a代表Array。
整体缩写采用从右至左的分析方式，举例如下：
Boolean数组命名为abXXXX
单精度附点数数组命名为afsXXXX
结构数组命名为arXXXX
枚举数组命名为aeXXXX
指针数组命名为apXXXX
字符集合命名为mcXXXX
32位整数集合数组命名为amnXXXX
结构指针命名为prXXXX
PChar命名为pszXXXX
PChar数组命名为apszXXXX
4.1.4命名中限制的法则
全局冠以g_
模块级冠以m_
常量以C_开始
全局常量以gC_开头，模块级常量则mC_
4.1.5其它命名
类型的命名采用Delphi通用的TXxxxYyyyZzzz形式
枚举型变量的元素命名为以小写的类型英文名字母缩写开始，如TFontStyle=（fsBold,fsItalic,...）
类型常量命名为C_类型缩写_XxxxYyyy形式，无类型常量命名为C_含义或分组名_XxxxYyyy。
其中XxxxYyyy要描述常量含义，可以归为一类的常量；
有时Xxxx说明分组含义，而Yyyy为常量含义，如C_FontSizeBig=20,C_FontSizeNormal=12,C_FontSizeSmall=8。
举例：
C_as_FileNames:
array[0..2]ofstring=（‘C:
\AUTOEXEC.BAT’,‘C:
\CONFIG.SYS’,‘C:
\IO.SYS）和gC_MaxUsers=500分别定义了“局部一维字符串数组常量”和“全局常数”。
4.2文件及窗体命名
类名
命名格式
工程文件
Program（.DPR）
XXXX_P
单元
Unit（PAS）
XXXX_U
窗体
Form.Name（.DFM）
XXXX_F
数据模块
DataModule
XXXX_DM
4.3控件命名
4.3.1Standard页控件
TMainMenu
mmnuXXXX
TPopupMenu
pmnuXXXX
TLabel
lblXXXX
TEdit
edtXXXX
TMemo
mmoXXXX
TButton
btnXXXX
TCheckBox
chkXXXX
TRadioButton
rdbtXXXX
TListBox
lbxXXXX
TComboBox
cbxXXXX
TScrollBar
scbrXXXX
TGroupBox
gbxXXXX
TRadioGroup
rgpXXXX
TPanel
pnlXXXX
TActionList
actsXXXX
4.3.2Additional页控件
TBitBtn
btbtXXXX
TSpeedButton
spbtXXXX
TMaskEdit
medtXXXX
TStringGrid
sgrdXXXX
TDrawGrid
dgrdXXXX
TImage
imgsXXXX
TShape
shpXXXX
TBevel
bvlXXXX
TScrollBox
scbxXXXX
TCheckListBox
chksXXXX
TSplitter
spltXXXX
TStaticText
stxtXXXX
TControlBar
ctbrXXXX
TChart
chtXXXX
4.3.3Win32页控件
TTabControl
tctlXXXX
TPageControl
pctlXXXX
TImageList
TRichEdit
redtXXXX
TTrackBar
tkbrXXXX
TProgressBar
pgbrXXXX
TUpDown
updnXXXX
THotKey
htkXXXX
TAnimate
anmtXXXX
TDateTimePicker
dtpXXXX
TMonthCalendar
mcldXXXX
TTreeView
tvwXXXX
TListView
lvwXXXX
THeaderControl
hctlXXXX
TStatusBar
stbrXXXX
TToolBar
tlbrXXXX
TCoolBar
clbrXXXX
TPageScroller
psclXXXX
4.3.4System页控件
TTimer
tmrXXXX
TPaintBox
ptbxXXXX
TMediaPlayer
mplrXXXX
TOLEContainer
olectXXXX
TDDEClientConv
ddeccXXXX
TDDEClientItem
ddeciXXXX
TDDEServerConv
ddescXXXX
TDDEServerItem
ddesiXXXX
4.3.5Internet页控件
TClientSocket
XxxxClientSocket
TServerSocket
XxxxServerSocket
TWebDispatcher
XxxxWebDispatcher
TPageProducer
XxxxPageProducer
TQueryTableProducer
XxxxQTProducer
TDataSetTableProceducer
XxxxDSTProducer
TDataSetPageProceducer
XxxxDSPProducer
TNMDayTime
XxxxNMDayTime
TNMEcho
XxxxNMEcho
TNMFinger
XxxxNMFinger
TNMFTP
XxxxNMFTP
TNMHTTP
XxxxNMHTTP
TNMMsg
XxxxNMMsg
TNMMSGServ
XxxxNMMsgServ
TNMNNTP
XxxxNMNNTP
TNMPOP3
XxxxNMPOP3
TNMUUProcessor
XxxxNMUUProcessor
TNMSMTP
XxxxNMSMTP
TNMStrm
XxxxNMStrm
TNMStrmServ
XxxxNMStrmServ
TNMTime
XxxxNMTime
TNMUDP
XxxxNMUDP
TPowerSock
XxxxPowerSock
TNMGeneralServer
XxxxNMGeneralServer
THTML
XxxxHTML
TNMURL
XxxxNMURL
4.3.6DataAccess页控件
TDataSource
dsXXXX
TTable
tblXXXX
TQuery
qryXXXX
TStoredProc
sprcXXXX
TDatabase
dbXXXX
TSession
ssnXXXX
TBatchMove
bmvXXXX
TUpdateSQL
updtXXXX
TNestedTable
ntblXXXX
4.3.7DataControls页控件
TDBGrid
dbgrdXXXX
TDBNavegator
dbnvXXXX
TDBText
dbtxtXXXX
TDBEdit
dbedtXXXX
TDBMemo
dbmmoXXXX
TDBImage
dbimgXXXX
TDBListBox
dblbxXXXX
TDBComboBox
dbcbxXXXX
TDBCheckBox
dbchkXXXX
TDBRadioGroup
dbrgpXXXX
TDBLookupListBox
dbllbXXXX
TDBLookupComboBox
dblcbXXXX
TDBRichEdit
dbredXXXX
TDBCtrlGrid
dbcgdXXXX
TDBChart
dbchtXXXX
4.3.8Midas页控件
TClientDataSet
cltdsXXXX
TDCOMConnection
dcmcnXXXX
TCorbaConnection
crbcnXXXX
TSocketConnection
sktcnXXXX
TOLEnterpriseConnection
olecnXXXX
TDataSetProvider
dsprdXXXX
TProvider
prvdrXXXX
TSimpleObjectBroker
sobkrXXXX
TRemoteServer
rmtsvXXXX
TMidasConnection
mdscnXXXX
4.3.9DecisionCube页控件
TDecisionCube
dccbXXXX
TDecisionQuery
dcqryXXXX
TDecisionSource
dcsrXXXX
TDecisionPivot
dcpvtXXXX
TDecisionGrid
dcgrdXXXX
TDecisionGraph
dcchtXXXX
4.3.10QReport页控件
TQuickRep
qrptXXXX
TQRSubDetail
qrsdtXXXX
TQRStringsBand
qrsbdXXXX
TQRBand
qrbdXXXX
TQRChildBand
qrcbdXXXX
TQRGroup
qrgrpXXXX
TQRLabel
qrlblXXXX
TQRDBText
qrdbtXXXX
TQRExpr
qrxprXXXX
TQRSysData
qrsysXXXX
TQRMemo
qrmmoXXXX
TQRExprMemo
qrxpmXXXX
TQRRichEdit
qrredXXXX
TQRDBRichEdit
qrdbrXXXX
TQRShape
qrshpXXXX
TQRImage
qrimgXXXX
TQRDBImage
qrdbiXXXX
TQRCompositeReport
qrcrpXXXX
TQRPreview
qrprvXXXX
TQRTextFilter
qrtflXXXX
TQRCSVFilter
qrcsvXXXX
TQRHTMLFilter
qrhtfXXXX
TQRChart
qrchtXXXX
4.3.11Dialogs页控件
TOpenDialog
opdgXXXX
TSaveDialog
svdgXXXX
TOpenPictureDialog
oppdgXXXX
TSavePictureDialog
svpdgXXXX
TFontDialog
ftdgXXXX
TColorDialog
cldgXXXX
TPrintDialog
prdgXXXX
TPrinterSetupDialog
psdgXXXX
TFindDialog
fndgXXXX
TReplaceDialog
rpdgXXXX
4.3.12Win3.1页控件
TDBLookupList
dbllsXXXX
TDBLookupCombo
TTabSet
tbstXXXX
TOutLine
otlnXXXX
TTabbedNoteBook
tnbkXXXX
TNoteBook
ntbkXXXX
THeader
hdrXXXX
TFile
升级会员 