C# .NET 代码编程规范.docVIP

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 对象类型标志 1.3函数命名：函数由标志函数功能的英文单词或词组构成。函数的首字母应该大写，词组中每个词的首字母也应该大写，某写专有名词或缩写按照习惯用法确定大小写，如:MDI、ActivtX等。 函数命名最好采用相关的英文表述，可以讨论那些比较难定义的名称，经过积累形成常用术语表。 书写格式 2.1缩进：采用系统自动生成的缩进格式。 2.2程序段: 采用系统自动生成的排步格式。 2.3语句：为保证代码的易读性，要求完整地将语句写出。比如注意{}的完整性。 代码要求 3.1一般原则： 1．写清晰的代码：比如定义变量的代码和使用变量的代码要尽量靠近，写代码应该注意程序动作的连续性，不要在某处对一个变量赋值，又在100行代码以后才使用它等等。 2．写简单的代码：比如，不要为提高效率或为了使代码看来短一些而采用一些繁琐深奥的技巧等等，对效率要求很高的复杂代码请完整注释并写专门的文档。 3．时刻注意系统开销：比如，不要保留不使用的变量和代码；不要为数组定义超过使用需要的空间，局部使用的变量尽量定义在局部{}以内，便于GC及时清除垃圾； 4．保证系统的一致性，减少未知难以调试的错误：比如，尽量少使用类全局变量；在使用全局变量时应尽量避免在多处都可写的情况发生； 5．时刻注意对浮点数据类型的处理：比如，若浮点类型变量dblA,dblB进行比较时，采用 If（dblA-dblB）=0 的判断是错误的。 3.2函数和过程的使用：当某段代码的使用次数超过一次而又具有一定的代表性时，应该采用函数或过程的方式来处理；在窗体中出现的响应事件的函数的代码长度应该限制在300行以内，否则使用过程或函数来实现；当某个模块中的代码太长时，应尽量根据语句的意群分割为过程或函数。 3.3程序注释：程序的注释包括程序头说明及代码注释。在函数头中输入///系统即可自动为你产生注释段,而且可以利用IDE提供的工具来生成文档。 3.3.1程序头说明：说明本程序的作者；代码时间、作者、功能。如果调用复杂，采用附带使用的例子，采用example和code来完成 举例如下： /// summary /// 功能:返回给定的技术参数 /// 作者:Anord Young /// 日期:2000-09-11 ////summary /// param name=name /// 名称：名字 作用：输入得名称/param /// return /// 返回属性字符串/return ///example 以下就是使用的例子 ///code ///public static void Main(string[] srgs) ////....... /////code ////example 3.3.2代码注释：对于关键业务采用分块的注释方法，对于所有的具有意义的变量必须注