《C#编码规范》PPT课件.ppt

《《C#编码规范》PPT课件.ppt》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、一、概述二、实例讲解三、注意点四、Q&AC#编码规范编码规范概述编码规范的必要性：多人协作时，代码清晰易懂。容易发现代码的问题，调试时比较容易。体现部门形象。编码规范的要点：排版规范（缩进、空行）。注释规范清晰。类名、方法名定义规范（大小写）。变量定义规范（大小写、变量有意义）。C#的编码规范制定原则：1参照微软在VS.NET中，C#既有的规范来制定。2方便代码的交流和维护。3不影响编码的效率，不与大众习惯冲突。4使代码更美观、阅读更方便。5使代码的逻辑更清晰、更易于理解。遵守原则：首先遵守客户

2、要求的规则。在客户没有指定规则的情况下，遵守本规则。编码规范概述编码规范概述C#的编码规范术语定义：Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：BackColorCamel大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor匈牙利大小写标示符的首字母用类型的简写，而每个后面连接的单词的首字母大写。例如：strBackColor编码规范概述匈牙利命名法特点：基本原则是：变量名＝属

3、性＋类型＋对象描述，其中每一对象的名称都要求有明确含义，可以取对象名字全称或名字的一部分。命名要基于容易记忆容易理解的原则。保证名字的连贯性是非常重要的。举例：表单的名称为form，那么在匈牙利命名法中可以简写为frm，则当表单变量名称为Switchboard时，变量全称应该为frmSwitchboard。这样可以很容易从变量名看出Switchboard是一个表单，同样，如果此变量类型为标签，那么就应命名成lblSwitchboard。可以看出，匈牙利命名法非常便于记忆，而且使变量名非常清晰易懂

4、，这样，增强了代码的可读性，方便各程序员之间相互交流代码。编码规范概述命名概述：名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用GetNextStudent()，而不是GetNextArrayElement()。命名原则是：选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可

5、以理解的名称是有意义的。不过，请确保选择的名称符合适用语言的规则和标准。编码规范概述以下几点是推荐的命名方法：1、避免容易被主观解释的难懂的名称，如方面名AnalyzeThis()，或者属性名xxK8。这样的名称会导致多义性。2、在类属性的名称中包含类名是多余的，如Book.BookTitle。而是应该使用Book.Title。3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。4、在变量名中使用互补对，如min/max、begin/end和open/c

6、lose。5、布尔变量名应该包含Is/bln，这意味着Yes/No或True/False值，如FileIsFound。6、在命名状态变量时，避免使用诸如Flag的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用documentFlag，而是使用更具描述性的名称，如documentFormatType。（此项只供参考）7、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如i或j。可能的情况下，尽量不要使用原义数字或

7、原义字符串，如Fori=1To7。而是使用命名常数，如Fori=1ToNUM_DAYS_IN_WEEK以便于维护和理解。编码规范概述大小写规则：标识符中的所有首字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：usingSystem.IOusingSystem.Web.UI下表汇总了大写规则，并提供了不同类型的标识符的示例。标志符大小写方式示例类PascalAppDomain枚举类型PascalErrorLevel枚举值PascalFatalError事件PascalValueC

8、hanged异常类PascalWebException只读的静态字段PascalRedValue接口IPascalIDisposable方法PascalToString命名空间PascalSystem.Drawing参数cameltypeName属性PascalBackColor中间层方法接口IPascalILogin私有字段camel_UserName控件命名匈牙利txtUserName局部变量camel/匈牙利textLength/iLength使用单词缩写和首字母缩写词为了避免混淆和保证跨