文档介绍:C# WEB程序开发规范
说明:本文档是项目小组进行代码检查的依据文件。
变量及对象命名:变量及对象采用匈牙利命名法,任何变量由三部分组成,标志变量作用范围的标志+标志变量类型的标志+标志该文件功能的英文词组或词组缩写构成。作用范围标志C# WEB程序开发规范
说明:本文档是项目小组进行代码检查的依据文件。
变量及对象命名:变量及对象采用匈牙利命名法,任何变量由三部分组成,标志变量作用范围的标志+标志变量类型的标志+标志该文件功能的英文词组或词组缩写构成。作用范围标志及变量类型标志采用小写,词组中每个词的首字母应该大写,某写专有名词或缩写按照****惯用法确定大小写,如:MDI、ActivtX等。
常用标志如下:
内容
标志
说明
全局标量
g_
作用域标志
模块级变量
m_
作用域标志
局部变量
无
作用域标志
函数内部临时循环变量
i,j,k
为了简单起见,对于这些变量不要过于复杂
Bool
bln
简单类型标志
Byte
byt
简单类型标志
Int
int
简单类型标志
Long
lng
简单类型标志
Float
flt
简单类型标志
Double
dbl
简单类型标志
String
str
简单类型标志
TextBox
txt
控件类型标志
CommandButton
btn
控件类型标志
Frame
fra
控件类型标志
CheckBox
chk
控件类型标志
OptionButton
opt
控件类型标志
ListBox
lst
控件类型标志
ComboBox
cbo
控件类型标志
Label
lbl
控件类型标志
DataGrid
dgd
控件类型标志
Calender
cdr
控件类型标志
Datepicker
Dtp
控件类型标志
Dataset
dst
对象类型标志
DataReader
drd
对象类型标志
Data Connection
con
对象类型标志
Data Command
dcd
对象类型标志
Data Adapter
dat
对象类型标志
Object
obj
对象类型标志
:函数由标志函数功能的英文单词或词组构成。函数的首字母应该大写,词组中每个词的首字母也应该大写,某写专有名词或缩写按照****惯用法确定大小写,如:MDI、ActivtX等。
函数命名最好采用相关的英文表述,可以讨论那些比较难定义的名称,经过积累形成常用术语表。
书写格式
:采用系统自动生成的缩进格式。
:采用系统自动生成的排步格式。
:为保证代码的易读性,要求完整地将语句写出。比如注意{}的完整性。
代码要求
:
1.写清晰的代码:比如定义变量的代码和使用变量的代码要尽量靠近,写代码应该注意程序动作的连续性,不要在某处对一个变量赋值,又在100行代码以后才使用它等等。
2.写简单的代码:比如,不要为提高效率或为了使代码看来短一些而采用一些繁琐深奥的技巧等等,对效率要求很高的复杂代码请完整注释并写专门的文档。
3.时刻注意系统开销:比如,不要保留不使用的变量和代码;不要为数组定义超过