Net设计规范.docVIP

.Net设计规范 精心设计的柜架所具备的品质： 1.精心设计的柜架是简单的。 规范是为了在功能强大和简单性之间保持合理的平衡而制定的。 2.精心设计的框架设计代价高 3.精心设计的柜架充满利弊权衡。 4.精心设计的柜架应该借鉴过去。 5.精心设计的柜架要考虑未来发展。 6.精心设计的柜架应具有良好的集成性。 7.精心设计的柜架是一致的。 一致性是精心设计的柜架的关键特征，它是影响开发效率的最重要因素之一。一致的柜架可c以使开发人员从柜架中已了解的部分推知不了解的部分。 命名规范 3.1大小写约定 为了区分一个标识符中的多个单词，把标识符中的每个单词的首字母大写。不要用下划线来区分单词，或者在标识符中的任何地方使用下划线。 PascalCasing 约定被用于除了参数名之外的所有标识符，它把标识符中每单词的首字母（包括长度为两个字符以上的首字母缩写词）大写，例： PropertyDescriptor HtmlTag 两个字母长的首字母缩写词是一个特例，在这种情况下两个字母都要大写，如：IOStream camelCasing 约定公用于参数的名字，它把标识符中除了第一个单词之外的所有单词的首字母大写。如果camelCasing风格的标识符以两个字母长的首字母缩写词开始，那么两个字母都要小写。 例：PropertyDescriptor ioStream htmlTag 3.1.1标识符的基本大小写规范： 1.要把PascalCasing用于由多个单词构成的名字空间、类型以及成员的名称。 例：要使用TextColor而不是Textcolor或Text_color。 始终作为一个单词的复合词(比如endpoint)视为一个单词，只有第一个字母大写。 2.要把camel Casing用于参数的名字 注：几乎不应该使用公开暴露给外界的实例字体，而使用属性。 3.1.2首字母缩写词的大小写 要把两个字母的字母的首字母缩写词全部大写，队非它是camelCasing风格的参数名的第一个单词。 System.IO Public void StartIO(Stream ioStream) 要把由三个或三个以上字母组成的首字母缩写词的第一个字母大写。只有第一个字母大写，除非首字母缩写词是camelCasing风格的标识符的第一个单词。 System.Xml Public void ProcessHtmlTag(string htmlTag) 不要把camelCasing风格的标识符头部的任何首字母缩写词的任何字母大写，无论首字母缩写词的长度是多少。 3.1.3复合词和常用术语的大小写 在涉及大小写时，大多数复合词术语要作为单个单词处理。 不要把所谓闭合形式的复合词中每个单词的首字母大写。 常用的复合词和常用术语的大小写及拼写 Pascal Camel Not BitFlag bitFlag Bitflag Callback callback CallBack Canceled canceled Cancelled DoNot doNot Dont Email email EMail Endpoint endpoint EndPoint FileName fileName Filename Gridline gridline GridLine Hashtable hastable HashTable Id id ID Indexes indexes indices LogOff logOff LogOut LogOn logOn LogIn Metadata metadata MetaData,metaData Multipanel multipanel MultiPanel Multiview multiview MultiView Namespace namespace NameSpace Ok ok OK Pi pi PI Placeholder placeholder PlaceHolder SignIn signIn SignOn SignOut SignOut SignOff UserName userName Username WhiteSpace whiteSpace Whitespace Writable writable Writeable 3.1.4是否区分大小写 任何外部可访问的API不应该通过大小写来区分位于同一个上下文中的两个名字。 3.2 通用命名约定 3.2.1 单词的选择 要为标识符选择易于阅读的名称。 例如：一个命为HorizontalAlignment的属性就比AlignmentHorizontal更易于阅读。 要更看重可读性，而不是更看重简短性。属性名