C_代码编写规范.docVIP

1.前言 1.1.文档目的 本文档主要提供公司内部用C#语言进行编程时的编码标准，这个标准能帮助程序开发人员更好地进行产品开发，避免陷阱，还可以方便开发团队内部的交流。 本文档的主要读者是公司全体开发人员。 1.2文档范围 本文档仅包含C#语言的编码标准。 2.命名约定和风格 1）定义类型、方法名、属性名和常量使用Pascal命名规范。Pascal方式：所有单词第一个字母大写，其他字母小写。 public class SomeClass { const int DefaultSize=100; public void SomeMethod() { } } 2）定义局部变量和方法的参数使用Camel命名规范。Camel方式：除第一个单词外，单词第一个字母大写，其他字母小写。 int myNumberValue； void MyMethod(int myParamValue) { } 3）接口的名称前加上I。 interface IMyInterface { } 4）在私有(private)字段成员变量前面加上m_。 public class SomeClass . { private int m_UserID; private string m_UserName； } 5）所有字段成员变量应该定义在前面，和属性或方法间空开一行。 public class MyClass . { private int m_UserID; . private string m_UserName; public void SomeMethod1() . {…} public void SomeMethod2() {…} } 6)局部变量的定尽可能靠近它的初次使用，尤其是临时循环变量。 7）命名方法时采用“动词-对象”对，例如ShowDialog()。 8）有返回值的方法应该取名表示其返回值，例如GetObjectState()。 9）采用描述性的变量名。 ●除非在循环中使用的临时循环变量，就避免采用单字母的变量名，如i或t,而是采用index或temp。 ●对public和protected成员避免采用匈牙利命名法，就采用Pascal命名规范。 ●不要采用缩写（例如将number缩写为num）。 10）常用控件或对象的取名，采用使用匈牙利命名法，即使用控件类型（小写两个或三个字符）作为前缀。 控件或对象类型 前缀 控件或对象类型 前缀 窗体 frm 多页控件 Tab 按钮 btn 定时器 tmr 文本框 txt 标签 lbl 图片框 pic 图片 img 列表框 lst 组合框 cbo 树形控件 tv 列表控件 lv 进度条 pb 状态条 sb 菜单条 mnu 工具条 tbr 表格控件 grd 图片控件 iml 一般对象 obj 11）总是使用C#预定义的类型，而不是使用System命名空间中的别名。例如： ●采用object不用Object ●采用string不用String ●采用int不用Int32。 12）对于泛型，类型采用大写字母。当处理.Net类型Type时保留后缀Type。 //正确： Public class LinkedListK,T //避免使用： Public class LinkedListKeyType,DataType 13）自定义属性类型名采用Attribute作为后缀。 14）自定义异常类型名采用Exception作为后缀。 15）文件名应该体现其包含的类，通常与类名相同。 定义Hy.FC.DBUtility类的文件名是DBUtility.cs 16）当使用partial类型且每部分分配一个文件时，以类型名加P和序数命名每个文件。 //In MyClassP1.cs Public partial class MyClass {…} //In MyClassP2.cs Public partial class MyClass {…} 17）采用有意义的自定义命名空间名，格式为公司名称（Hy）+产品名称+类库名称。 using Hy.FC.DBUtility; using Hy.Pems.App; using SDPW.LBT.Utility; 18）避免使用类的全称，而是采用using语句。 19）避免在命名空间内使用using语句。 20）将所有Framework命名空间名放在一起，后面放自定义或第三方的命名空间名。 using System; using System.Data; using MyCompany; using MyControls; 21）严格遵守缩进格式，使用标准的Tab缩进。 22）注释缩进和其注释的代码在同一层次。 23）对类