I. Introduction
1. The importance of design specifications
The entire software development process is a fairly complex process. It is not a single designer to write code there. Often there will be no expected situations in software development, such as customer demand continues to change, designers lose Wait, in order to ensure the quality of the software, it is possible to meet the customer's satisfaction and meet the market requirements. The more improved the early work, the lower rework, the lower the price increase, the lower the development and design. It is very necessary to make coding and naming for different developers, such as widespread use of Hungarian rules), which helps to develop the software throughout the software and actively role in secondary development.
2. Scope of application specifications
This specification applies to common visual software development tools, such as Delphi, VC, VB, .NET, and Web Development Language ASP (VBScript, JavaScript, JScript scripting language), PHP, JSP, etc., there will be some differences for different tools, The part will be explained. Due to time, it is relatively simple, and it is more simple, and it has also taken it in the development of yourself.
Second, the explanatory document specification
Description of the specification
1) Write the file header in each program file, indicating the role of the entire file
2) In the words of language --------------------------- Start and end, such as Delphi is //, ASP is'
3) File Name: File Name
4) Author author Version version Date completion date
5) Description: The main function of this program file, the interface, output value, value range, meaning, and parameter control, order, independent or dependence, etc.
6) Others: Other contents
7) Function List: Major function list, each record should contain function names and brief description
8) History: Modify the list of history, each record should include modify the author, modify the date, and modify content
2. Specific example
Asp as an example
'------------------------------------- ----------------
'File Name: MsgView.asp
'Author: Name Version: 1.0 Date:
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
PERM
Ission TO Send
'Message or not;
'2) ViewFriend (): View all user's friend;
'History:
'1) Check Spelical Characters by Jack On
2004/5/2
'------------------------------------- ----------------
Third, process annotation specification
Description of the specification
1) Write at the beginning of the process, with an annotated man -------------------------- start ending
2) DESCRIPTION: Function Description
3) Author author Date completed the date
4)
Para
Meters: Parameter Description
5)
Cal
LS: Functions and procedures called by this process
6)
Cal
LED BY: Call the function or process list of this process
7) Table Accessed: Accessible table (program only involving database operation)
8) Table Updated: The modified table (program only involving database operation)
9) History: Modify the list of historical records, each record should include modify the author, modify the content and modification time
2. Specific example
Take Delphi as an example
/ * ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---
Description: Test
NetWork
Conn
ecry
Author: Peter Date:
2003/1/11
Para
Meters: SIP CHAR [15] (Remote IP Address)
Cal
LS: None
Cal
Led by: btntestConnection_Click ()
Table Accessed: None
Table Updated: None
History: None
-------------------------------------------------- ---- * /
Fourth, function note specification
Description of the specification
1) Write in the beginning of the function, add in the comment -------------------------- start ending
2) DESCRIPTION: Function Description
3) Author author Date completed the date
4)
Para
Meters: Parameter Description
5) RETURN: Return value description
6)
Cal
Ls: Functions and procedures called by this function
7)
Cal
LED BY: Call the function or process list of this function
8) Table Accessed: Acuted tables (programs involving database operation only)
9) Table Updated: The modified table (program only involving database operation)
10) History: Modify the history list, each record should include modify the author, modify the content, and modification time
2. Specific example
Take Delphi as an example
/ * ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---
Description: Get Mac Address from network network
ADA
PTER
Author: Peter Date:
2004/2/11
Para
Meters: SIP Char [15]
Return:
Mac ST
Ring
Cal
LS: None
Cal
LED by: showuserinfo ()
Table Accessed: None
Table Updated: None
History: None
-------------------------------------------------- ---- * /
V. Naming Regulations
1. Target for variable named
1) Express the use of variables
2) Make the data type and visible range of each variable clearly
3) Easy to understand the process in the code
4) Make the program easy to debug
5) Make the storage and processing of the variable more effective
2. Common naming of controls
Ordinary control
name
Prefix
Example
Button
BTN
Btnsubmit
Calendar
Cal
Calbirthday
Checkbox
chk
Chkblue
Checkboxlist
chKL
Chklfavcolors
DataGrid
DGRD
DGRDTISLES
Datalist
DLST
Dlsttitles
DropDownList
Drop
Dropbirdhyear
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 control
Connection
CON
Connorthwind
CommandCMD
cmdreturnpages
Parameter
PARM
PARMUSID
DataAdapter
DAD
DADPRODUCTS
DataReader
DTR
DTRPRODUCTS
Dataset
DST
DSTUSER
Datarable
DTBL
DTBLPRODUCTS
DataRow
Drow
DROWROW9
DataView
DVW
DVWFilteredUsers
Datacolumn
DCOL
DCOLUSERID
DataRelation
Drel
DrelmasterDetail
3. Naming of variable objects
Types of
Prefix
Example
Charr
c
CText
Byte
BY
BYIMAGE
Boolean
B
BRESULT
String
s
SIP (VB, ASP)
ColorRef
CR
CRFAVColor
coordinate
CX, CY
Double word
DW
DWSPEED
Integer
i
Iyear
Array
a
ATEMP
Object
o
Oconn
Short integer
n
Nwait
Long
l
LWORD
Float
fly
fText
