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

《C#编程规范(研发中心)》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、C#编程规范一、规范目的1：一个软件的生命周期中，80%的花费在于维护；合理的规范可以减少后期开发人员对代码的维护。2：编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。为了执行规范，每个软件开发人员必须一致遵守编码规范；3：使用统一编码规范的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解这段代码；4：好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。二、适用范围研发中心全体.NET开发人员。三、规范内容3.1命名规范变量，类等命名方式主要采用以下两种：序号名称规范实例1Pascal所有单词第一个字母大写，

2、其他字母小写如：HelloWorld。此方式主要用于类，方法等命名2Camel 除了第一个单词，所有单词第一个字母大写，其他字母小写如：helloWorld。此方式主要用于变量命名。3匈牙利命名法所有命名加前缀如btnXX,txtXX。可用在界面上一些按钮，文本或变量的定义。3.1.1变量命名规范1：变量和方法参数使用Camel大小写形式如：publicclassHelloWorld{inttotalCount=0;voidSayHello(stringname){stringfullMessage="Hello"+name;...}}２：不要使用匈牙利方法来命名变量。即采用“

3、_”或“X_”做为前缀，例如：stringm_sName；Object_obj；等。所有变量均采用camel大小写形式。３：不要用“_”或“&”等特殊字符作为第一个字母；４：用有意义的，描述性的词语来命名变量。项目中可商量是否统一采用中文拼音的首字母来做为变量或参数的命名。3.1.2属性命名规范１：用名词或名词短语命名属性。２：用Pascal大写命名属性。3.1.3方法命名规范１：如果方法返回一个成员变量的值，方法名一般为Get+成员变量名，如若返回的值是bool变量，一般以Is作为前缀。另外，如果必要，考虑用属性来替代方法；２：如果方法修改一个成员变量的值，方法名一般为：Se

4、t+成员变量名。同上，考虑用属性来替代方法。３：用动词或动词短语命名方法。４：使用Pascal大写方式命名方法。如下所示：voidRemoveAll()stringGetCharArray()boolIsContain()3.1.4类命名规范１：用名词或名词短语命名类２：使用Pascal大写。３：不要使用任何类前缀以及不要使用带下划线的字符。４：泛型类型参数的命名：命名要为T或者以T开头的描述性名字，例如：publicclassListpublicclassMyClass５：对同一项目的不同命名空间中的类，命名避免重复，避免引用时的冲突和混淆。6：自定

5、将异常类使用Exception作为后缀，如MyException。3.1.5接口命名规范１：所有接口命名都以I做为开头，以表示这个类型是一个接口。２：使用名词或名词短语，或者描述行为的形容词来命名接口。３：使用Pascal大写。同时I不算在内。如：IComponent（描述性名词），ICustomAttributeProvider（名词短语），和IPersistable（形容词）４：不要在任何地方使用带下划线或其经特殊的字符。3.1.6事件命名规范1：定义为事件的委托，使用EventHandler做为后缀。如publicdelegatevoidMouseEventHandler

6、(objectsender,MouseEventArgse);2：考虑使用动词命名事件。3：使用Pascal命名，不要使用任何前缀或后缀。例如，使用Close，而不要使用OnClose。4：通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为OnXxx）。如：PublicvirtualvoidOnClose(){If(Close!=null){Close();}}3.1.7常量命名规范所有单词大写，多个单词之间用"_"隔开。如publicconststringPAGE_TITLE="Welcome";3.1.8静态字段命名规范1：使用Pascal大小写

7、2：对静态字段名称使用匈牙利语表示法加前缀。一般可采用“_”做为前缀。3：使用名词、名词短语或者名词的缩写命名静态字段。3.1.9项目和程序集命名采用　公司简称+项目名+模块名(可选)命名方式。3.2代码注释规范3.2.1代码注释约定所有的方法和函数都应该以描述这段代码功能的简明注释开始（方法是干什么）。但这种描述不应该包括执行过程细节（它是怎么做的），因为这常常是随时间而变的，而且这种描述会导致不必要的注释维护工作，甚至更糟—成为错误的注释。因此只需要简单描述此段代码的基本功能即可另外当参