|
引言：Kent Beck 曾經說過“我只是個更注重的程序規范的程序員而已”
目錄：
前言
說明性文件規范
過程注釋的規范
函數的注釋規范
命名規范
設計規范：
前言: 1.設計規范的重要性:理由N多, 不在多述
2. 本文適用性 :vb.net 開發 asp.net 開發
注釋代碼的目標：
1． 敘述清除]代碼的作用（是做什么，而不是怎么做）
2． 清楚說明代碼所要表達的思想和邏輯
3． 表明代碼中的重要轉折點
4． 減少代碼閱讀者在他們大腦中模擬代碼的運行
注意：注視應該說明代碼的目的，而不要去敘述怎么完成目標的結構，要講清為什么要那么做，而不是怎么去做
用特殊字符標識注釋的作者： ‘$ ‘@ 開頭的行 分別代表不同人寫的注釋代碼
一． 說明性文件規范(寫在每個.vb結尾的文件頭,說明整個文件的功能)
1.1 以’----------------------------------開始和結尾
1.2 File name: 文件名
1.3 Author作者 Version版本: Date及完成日期:
1.4 Description: 用于詳細說明此程序文件完成的主要功能，與其他模塊
或函數的接口，輸出值、取值范圍、含義及參數間的控
制、順序、獨立或依賴等關系
1.5 Others: 其它內容的說明
1.6 Function List: 主要函數列表，每條記錄應包括函數名及功能簡要說明
1.7 History: 修改歷史記錄列表，每條修改記錄應包括修改日期、修改
者及修改內容簡述
1. Date:
Author:
Modification:
2．。。。。。。。。。。。
二． 過程注釋的規范
2.1 以’----------------------------------開始和結尾
2.2 Description: 功能描述
2.3 Parameters :參數說明
2.4 Calls : 被本過程調用的函數或過程
2.5 Called By: 調用本過程的函數清單
2.6 Table Accessed: 被訪問的表（此項僅對于牽扯到數據庫操作的程序）
2.7 Table Updated: 被修改的表（此項僅對于牽扯到數據庫操作的程序）
三．函數的注釋規范
3．1 Function: 函數名稱
3．2 Description: 函數功能、性能等的描述
3．3 Calls: 被本函數調用的函數清單
3．4 Called By: 調用本函數的函數清單
3．5Table Accessed: // 被訪問的表（此項僅對于牽扯到數據庫操作的程序）
3．6 Table Updated: // 被修改的表（此項僅對于牽扯到數據庫操作的程序）
3．7 Parameters: // 輸入參數說明，包括每個參數的作
// 用、取值說明及參數間關系。
3．8 Return: // 函數返回值的說明
四 命名規范
4． 1件命名規范
(1)普通控件
名稱 前綴 示例
adrotator adrt adrtTopad
button btn btnSubmit
calendar cal calMeetingDates
CheckBox chk chkBlue
CheckBoxList chkl chkFavcolors
CompareValidator valc valcValidAge
CustomValidator valx valxDbcheck
DataGrid dgrd dgrdTitles
DataList dlst dlstTiltles
DriopDownList Drop drop
Hyperlink link lnkDetails
Image img imgAuntBetty
ImageButton Ibtn ibtnSubmit
Label lbl lblResults
LinkButton lbtn
ListBox lst
Panel pnl
RadioButton rad
RadopButtonList radl
RangeValidator valg
Regularexpression vale
Repeater rpt
RequiredFieldValidator valr
Table tbl
TableCell tblc
TableRow tblr
TextBox txt
Validationsummary vals
Xml xmlc
(2) ado.net 控件命名
connction con conNorthwind(con +數據庫名稱)
command cmd cmdReturnProducts
Parameter parm parmProductId
DataAdapter dad dadProducts
DataReader dtr dtrProducts
DataSet dst dstNorthwind
DataTable dtbl dtblPrpducts
DataRow drow drowRow98
DataColumn dcol dcolProductId
DataRelation drel drelMasterDetaril
Dataview dvw dvwfilteredProducts
(3)變量命名的目標：
1． 使變量的用途明確
2． 使每個變量的數據類型和可見范圍清晰明了
3． 使代碼中的過程易于理解
4． 使程序易于調試
5． 使變量的存儲和處理更為有效
其余見vb.net 程序設計規范（2）
|
