C#编程规范(研发中心).docVIP

C#编程规范 一、规范目的 1：一个软件的生命周期中，80%的花费在于维护；编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。为了执行规范，每个软件开发人员必须一致遵守编码规范； 使用统一编码规范的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解这段代码； 好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。 Pascal 所有单词第一个字母大写，其他字母小写 如：HelloWorld。此方式主要用于类，方法等命名 2 Camel? 除了第一个单词，所有单词第一个字母大写，其他字母小写 如：helloWorld。此方式主要用于变量命名。 3 匈牙利命名法 所有命名加前缀 如btnXX,txtXX。可用在界面上一些按钮，文本或变量的定义。 3.1.1变量命名规范 1：变量和方法参数使用Camel 大小写形式 如： public class HelloWorld { int totalCount = 0; void SayHello(string name) { string fullMessage = Hello + name; ... } } ２：不要使用匈牙利方法来命名变量。即采用“_”或“X_”做为前缀，例如：string m_sName；Object _obj；等。所有变量均采用camel 大小写形式。 ３：不要用“_”或“”等特殊字符作为第一个字母； ４：用有意义的，描述性的词语来命名变量。项目中可商量是否统一采用中文拼音的首字母来做为变量或参数的命名。 3.1.2属性命名规范 １：用名词或名词短语命名属性。 ２：用Pascal大写命名属性。 3.1.3 方法命名规范 １：如果方法返回一个成员变量的值，方法名一般为Get+成员变量名，如若返回的值 是bool变量，一般以Is作为前缀。另外，如果必要，考虑用属性来替代方法； ２：如果方法修改一个成员变量的值，方法名一般为：Set + 成员变量名。同上，考虑 用属性来替代方法。 ３：用动词或动词短语命名方法。 ４：使用Pascal大写方式命名方法。如下所示： void RemoveAll() string GetCharArray() bool IsContain() 3.1.4 类命名规范 １：用名词或名词短语命名类 ２：使用Pascal大写。 ３：不要使用任何类前缀以及不要使用带下划线的字符。 ４：泛型类型参数的命名：命名要为T或者以T开头的描述性名字，例如：public class ListT public class MyClassTsession ５：对同一项目的不同命名空间中的类，命名避免重复，避免引用时的冲突和混淆。 6：自定将异常类使用Exception作为后缀，如MyException。 3.1.5接口命名规范 １：所有接口命名都以I做为开头，以表示这个类型是一个接口。 ２：使用名词或名词短语，或者描述行为的形容词来命名接口。 ３：使用Pascal大写。同时I不算在内。如：IComponent（描述性名词），ICustomAttributeProvider（名词短语），和IPersistable（形容词） ４：不要在任何地方使用带下划线或其经特殊的字符。 3.1.6事件命名规范 1：定义为事件的委托，使用EventHandler做为后缀。如 public delegate void MouseEventHandler(object sender, MouseEventArgs e); 2：考虑使用动词命名事件。 3：使用Pascal命名，不要使用任何前缀或后缀。例如，使用 Close，而不要使用 OnClose。 4：通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为OnXxx）。如： Public virtual void OnClose() { If(Close!=null) { Close(); } } 3.1.7 常量命名规范 所有单词大写，多个单词之间用 _ 隔开。 如 public const string PAGE_TITLE = Welcome; 3.1.8 静态字段命名规范 1：使用Pascal大小写 2：对静态字段名称使用匈牙利语表示法加前缀。一般可采用“_”做为前缀。 3：使用名词、名词短语或者名词的缩写命名静态字段。 3.1.9项目和程序集命名 采用　公司简称+项目名+模块名(可选)命名方式。 3.2代码注释规范 3.2.1代码注释约定 所有的方法和函数都应该以描述这段代码功能的简明注释开始（方法是干什么）。 但这种描述不应该包括执行过程细节（它是怎