ASP.net编程规范之命名规范

1.       命名规范

1.1.       按钮ID命名：btn+按钮操作功能（如btnSave）

1.2.       其它控件：按钮ID命名：

A          与数据操作相关：其ID<.SPAN>为相应的字段名称，如果有多个控件对应一个字段，则按以下规范命名：字段名+”_”+顺序号(以01开头)

例子：页面有一TextBox控件，对应数据库表中的RightGroup字段，则其ID命名为 RightGroup如果页面有二个TextBox控件，都对应着数据库表中的PowerGroup字段，则其ID分别命名为PowerGroup_01, PowerGroup_02,依此类推

 

B          其它：前缀+用途功能（如txtInput）,前缀请看表一：

控件	前缀	控件	前缀
Form	frm	Class	cls/C
Module	mod	Label	lbl
LinkLabel	lnk	Button	btn
TextBox	txt	CheckBox	chk
RadioButton	rad	GroupBox	grp
PictureBox	pic	DataGrip	grd
ListBox	lst	CheckedListBox	clst
ComboBox	cbo	TreeView	tvw
ListView	lvw	TabControl	tab
DateTimePicker	dtp	Timer	tmr
Splitter	spl	ProgressBar	pbar
RichTextBox	rtf	ImageList	imgl
ToolBar	tlb	MenuItem	mnu

 

                            （表一）

1.3.       变量及常量命名规范：

A          页面及过程级变量：级别标识+数据类型前缀+<名词|名词组合>

i      页面级变量：级别标识为m (例子：dim mstrNewline as string)

ii     过程级变量：级别标识为 l (例子：dim lstrNewline as string)

B          页面间变量：采用request传递获取

命名原则：级别标识+数据类型前缀+<名词|名词组合>

                级别标识为p

例子：url=”XXXX.aspx?pstrLine=bbbbb&pintNum=<11”>

           Dim lstrLine as string=Request(“pstrLine”)

           Dim lintNum as integer=request(“pintNum”)

1.4.       变量及常量命名规范：

A          页面及过程级变量：级别标识+数据类型前缀+<名词|名词组合>

i      页面级变量：级别标识为m (例子：dim mstrNewline as string)

ii     过程级变量：级别标识为 l (例子：dim lstrNewline as string)

B          页面间变量：采用request传递获取

命名原则：级别标识+数据类型前缀+<名词|名词组合>

                级别标识为p

例子：url=”XXXX.aspx?pstrLine=bbbbb&pintNum=<11”>

           Dim lstrLine as string=Request(“pstrLine”)

           Dim lintNum as integer=request(“pintNum”)

 

C          全级变量：级别标识+数据类型前缀+<名词|名词组合>

i      命名原则：级别标识+数据类型前缀+<名词|名词组合>

ii     级别标识为g(例子：session(“gstrNewline”)=””)

iii   因为在所有的页面都能使用，所以须有足够长的名称以说明变量，并加上注释

iv   通用变量统一放在Global.asax中的Session_Start(sender,e)过程中，初始值赋予空字符串。并在Session_End(sender,e)过程中释放掉。

例子：

Global.asax文件：

 

Sub session_star(byval sender as Object,byval e as EventArgs)

    Session(“gstrUser”)=””

End sub

Sub session_End(byval sender as Object,byval e as EventArgs)

    Session(“gstrUser”)=nothing

End sub

v    通用变量的定义必须经过项目主管的同意后才能进行

D         数据类型前缀：

 

数据类型	前缀	数据类型	前缀
String	str	Date	dat
Boolean	bln	Short	sht
Decimal	dec	Long	lng
Integer	int	Byte	byt
Char	chr	Single	sgl
Double	dbl	Structure	udt
Object	obj	DataSet	ds
DataRow	dr	OleDbConnection	conn
SqlConnection	conn	OleDbCommand	cmd
SqlCommand	cmd	OleDbDataAdapter	da
SqlDataAdapter	da	OleDbDataReader	rdr
SqlDataReader	rdr	Crystal Report	rpt

                       （表二）

1.5.       过程（函数）命名规范：

A          命名规范：级别标识+<动名词结构>

B          应用于单一页面：级别标识为p(例子：private function pDisdata())

C          应用于全部页面：级别标识为g(例子：public function gDisdata())

1.6.       页面命名规范：模块标识+程序功能英文缩写：

A          例子：有基本资料模块，其模块标识为Base,程序使用的英文缩写为Unit,则页面名称为BaseUnit

B          此命名只能由项目主管或系统分析设定

1.7.       用户控件命名规范：

A          原则:[Url]+ <名词|名词组合|动名词组合>,名词|动词的第一个字母大写

B          例子:UrlDataLoad

C          用户控件的定义与命名必须经过项目主管的同意后才能进行