说明详细的net代码规范.docx

《说明详细的net代码规范.docx》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、.NET设计规范武汉无线飞翔科技有限公司.NET设计规范1命名规范1.1大小写约定PascalCasing将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：BackColorcamelCasing标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor对于由多个单词组成的所有公共成员、类ss型及命名空间名称，要使用Pascal大小写。对参数名称使用大小写混合。下表汇总了标识符的大小写规则，并提供了不同类型标识符的示例。表不同类型的标识符的大

2、小写规则标识符大小写方式示例类PascalAppDomain枚举类型PascalErrorLevel枚举值PascalFatalError事件PascalValueChanged异常类PascalWebException只读的静态字段PascalRedValue接口PascalIDisposable方法PascalToString命名空间PascalSystem.Drawing参数CameltypeName属性PascalBackColor首字母缩写词与单词缩写首字母缩写词是由一个短语的首字母组成的，而单词缩写则仅仅把一个单

3、词的长度变短。要把两个字母的首字母缩写词全部大写，除非他是camelCasing风格的参数名的第一个单词。System.IOpublicvoidStartIO(StreamioStream)第51页共51页.NET设计规范武汉无线飞翔科技有限公司要把由三个或三个以上字母组成的首字母缩写词的第一个字母大写。只有第一个字母大写，除非首字母缩写词是camelCasing风格的标识符的第一个单词。System.XmlpublicvoidProcessHtmlTag(stringhtmlTag)在涉及大小写时，大多数复合词术语要作为单

4、个单词处理。不要把所谓闭合形式的复合词中每个单词的首字母大写。下表列出一些常用的复合词和常用术语的大小写。表常用的复合词和常用术语的大小写及拼写PascalCamelNotBitFlagbitFlagBitflagCallbackcallbackCallBackCanceledcanceledCancelledDoNotdoNotDontEmaildmailEMailEndpointdndpointEndPointFileNamefileNameFilenameGridlinegridlineGridLineHashtabl

5、ehashtableHashTableIdidIDIndexesindexesIndicesLogOfflogOffLogOutLogOnlogOnLogInMetadatametadataMetaData,metaDataMultipanelmultipanelMultiPanelMultiviewmultiviewMultiViewNamespacenamespaceNameSpaceOkokOKPipiPIPlaceholderplaceholderPlaceHolderSignInsignInSignOnSignOu

6、tsignOutSignOffSqlsqlSQLUserNameuserNameUsernameWhiteSpacewhiteSpaceWhitespaceWritablewritableWriteable1.1通用命名约定第51页共51页.NET设计规范武汉无线飞翔科技有限公司通用命名约定讨论的是如何为库元素选择最适当的名称。这些准则适用于所有标识符。后面各节讨论特定元素（如命名空间或属性）的命名。选择名称1.选择易读的标识符名称。例如，英文属性名称HorizontalAlignment比AlignmentHorizont

7、al更具可读性。可读性比简洁性更重要。属性名称CanScrollHorizontally比ScrollableX（指X轴，但意义不明确）更好。2.不要使用下划线、连字符或任何其他非字母数字字符。3.不要使用匈牙利表示法。匈牙利表示法是在标识符中使用一个前缀对参数的某些元数据进行编码，如标识符的数据类型。4.避免使用与常用编程语言的关键字冲突的标识符。虽然符合CLS的语言必须提供将关键字用作普通字的方法，最佳做法不要求强制开发人员了解如何实现。对于大多数编程语言，语言参考文档都会提供语言所使用的关键字列表。缩写和首字母缩写词通

8、常，不应使用缩写或首字母缩写词。这类名称的可读性较差。同样，要确定某个首字母缩写词是否已受到广泛认可也是很困难的。不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用OnButtonClick而不要使用OnBtnClick。除非必要，不要使用任何未被广泛接受的首字母缩写词。语言特定的名