很全的c#开发编码规范

《很全的c#开发编码规范》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、C#编程规范口录1前言21.1编写目的21.2范围22.规范内容22.1代码格式22.2命名指南32.2.1大写样式32.2.2区分大小写42.2.3缩写52.2.4措词52.2.5避免类型名称混淆62.2.6命名空间命名指南82.2.7类命名指南92.2.8类成员变量命名指南92.2.9接口命名指南102.2.10属性命名指南1()2.2.11枚举类型命名指南102.2.12静态字段命名指南112.2.13参数命名指南112.2.14方法命名指南122.2.15属性命名指南122216事件命名指南132.3注释(Comment)规范142.3.1模块(类)注释规范142.3.2类属性

2、注禅规范15233方法注释规范15234代码间注释规范153成功的模式163.1有效地使用这些标准163.2其它导向成功代码的因索161.1编写目的为了保证企业编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。1.2范适用于企业所有基于.NET平台的软件开发工作。2.规范内容2.1代码格式♦所有的缩进为4个空格，使用VS.NET的默认设置。♦在代码中垂直对齐左括号和右括号。if(x=O){Response.Write("用户编号必须输入!”);}不允许以下情况：if(x=0){Response.Write("用户编号必须输入!“)；}或者：if(x—0){Respo

3、nse.Write(，z用户编号必须输入!”);}♦为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示频率下不得超过一显示屏♦当一行被分为儿行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后而的行是不完整的。♦每一行上放置的语句避免超过一条。♦在大多数运算符Z前和Z后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。例：intj=i+k;而不应写为intj=i+k;♦将人的复杂代码节分为较小的、易于理解的模块。2.2命名指南2.2.1大写样式使用卜-面的三种大写标识符约定。Pascal大小写将标识符的首字母和后面连接的每个单词的首

4、字母都大写。可以对三字符或更多字符的标识符使用Pascal人小写。例如：BackColorCamel大小写标识符的首字母小写，而每个后面连接的单词的首字母都人写。例如：backColor大写标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：System.10System.Web.UI可能还必须大写标识符以维持少现有非托管符号方案的兼容性，在该方案中所有大写字母经常用于枚举和常数值。一般情况下，在使用它们的程序集Z外这些字符应当是不可见的。下表汇总了大写规则，并提供了不同类型的标识符的示例。标识符大小写示例类PascalAppDomain枚举类型Pascal

5、ErrorLevel枚举值PascalFatalError事件PascalValueChange异常类PascalWebException注意总是以Exception后缀结尾。只读的静态字段PascalRedValue接口PascalIDisposable注意总是以1前缀开始。方法PascalToString命名空间PascalSystem.Drawing参数CameltypeName属性PascalBackColor受保护的实例字CamelredValue段注意很少使用。属性优于使用受保护的实例字段公共实例字段PascalRedValue注意很少使用。属性优于使用公共实例字段。2.2

6、.2区分大小写为了避免混淆和保证跨语言交互操作，请遵循有关区分大小写的使用的下列规则：♦不耍使用要求区分大小写的名称。对于区分大小写和不区分大小写的语言，组件都必须完全可以使用。不区分大小写的语言无法区分同一上下文屮仅人小写不同的两个名称。因此，在创建的组件或类中必须避免这种情况。♦不要创建仅是名称大小写有区别的两个命名空间。例如，不区分大小写的语言无法区分以下两个命名空间声明。namespaceee.cummings;namespaceEe.Cummings;♦不要创建具有仅是大小写有区别的参数名称的函数。下而的示例是不正确的。voidMyFunction(stringa,strin

7、gA)♦不要创建具冇仅是大小写冇区别的类型名称的命名空间。在下面的示例中，Pointp和POINTp是不适当的类型名称，原因是它们仅是大小写有区别。System.Windows.Forms.PointpSystem.Windows.Forms.POINTp♦不要创建具有仅是人小写有区别的属性名称的类型。在下面的示例屮,intColor和intCOLOR是不适当的属性名称，原因是它们仅是大小写有区别。intColor{get,set}intCOL