C编码规范.docx

C#编码规范 1. 前言 所有c#，.NET项目都应严格遵守本代码规范中的代码书写要求，，所以请务必认真阅读本文档。 基本原则： 命名清晰规范，要做到命名无歧义，其作用一目了然。且做到有预见性，宁长勿短，防止因新需求造成的更改而产生的新旧名称命名混淆。 方法要小而短，做到每个方法只做一件事，提高可读性。一般来说参数不超过3个，如超出则需考虑模板化。方法超过50行应考虑细化拆分。一般来说在同一个类中时，被调用的方法放在调用的方法下。 推荐是用resharper等辅助工具，当出现不符合规范的编写方式时会给出提示，其具有的其他功能也有助于快速编码。 2. 大小写约定 大小写样式 本文中将出现两种大小写样式，这里先分别定义： Pascal大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如：BackColor Camel大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor?标识符大小写规则 下表中列出常见的代码元素的样式规范和示例 除了遵循以上大小写约定外还需注意以下约定（除常量为特例）： 1.如果标识符由多个单词组成，请不要在各单词之间使用分隔符，如下划线（“_”）或连字符（“-”）等。而应使用大小写来指示每个单词的开头。 2.所有公共的成员如：方法、属性，都应使用Pascal大小写样式 首缩写词的大小写规则 缩写词分为以下两种： 首字母缩写词 首字母缩写词是由术语或短语中各单词的首字母构成的单词。 例如，HTML 是 Hypertext Markup Language 的首字母缩写。 为了方便编码规范的实施，本文规定受字母缩写词必须至少为两个单词，正好为两个单词的首字母缩写词称其为“短型首字母缩写词” 两个单词以上的称其为“长型首字母缩写词” 单缩写词 单缩写词是一个单词的缩写。例如，ID 是 identifier 的缩写。 注意：可在标识符中使用的两个缩写词是 ID 和 OK。在采用 Pascal 大小写格式的标识符中，这两个缩写词的大小写形式应分别为 Id 和 Ok。 如果在采用大小写混合格式的标识符中将这两个缩写词用作首个单词，则它们的大小写形式应分别为 id 和 ok。 首字母缩写词有以下大小写规则： 短型首字母缩写词在Pascal大小写样式中，两个字母都应大写。在Camel大小写样式中，如果是首个单词，两个字母都应小写。 例如，名为 DBRate 的属性是一个采用 Pascal 大小写格式的标识符，它使用短型首字母缩写词 (DB) 作为首个单词。 又如，名为 ioChannel 的参数是一个采用大小写混合格式的标识符，它使用短型首字母缩写词 (IO) 作为首个单词。 长型首字母缩写词，在任何大小写样式中都视为一个单词。 例如，名为 XmlWriter 的类是一个采用 Pascal 大小写格式的标识符，它使用长型首字母缩写词作为首个单词。 又如，名为 htmlReader 的参数是一个采用大小写混合格式的标识符，它使用长型首字母缩写词作为首个单词。 复合词的大小写规则： 所有复合词在任何大小写样式中都视为一个完整单词。 例如，hashtable 是一个紧凑格式的复合词，应将其视为一个单词并相应地确定大小写。 如果采用 Pascal 大小写格式，则该复合词为 Hashtable;如果采用大小写混合格式，则该复合词为 hashtable。 若要确定某个单词是否是紧凑格式的复合词，请查阅必威体育精装版的词典。 区分大小写 大小写准则只是为了使标识符更易于阅读和辨认。不能将大小写规则用作避免库元素之间的命名冲突的手段。 3. 通用命名约定 通用命名约定讨论的是如何为库元素选择最适当的名称。这些准则适用于所有标识符。后面各节讨论特定元素（如命名空间或属性）的命名。 选择名称 1.请选择易读的标识符名称 例如，英文属性名称 HorizontalAlignment 比 AlignmentHorizontal 更具可读性。 2.可读性比简洁性更重要 例如，属性名称 CanScrollHorizontally 比 ScrollableX（指 X 轴，但意义不明确）更好。 3.不要使用下划线、连字符或任何其他非字母数字字符 4.不要使用匈牙利表示法 匈牙利表示法是在标识符中使用一个前缀对参数的某些元数据进行编码，如标识符的数据类型。 5.避免使用与常用编程语言的关键字冲突的标识符 虽然符合 CLS 的语言必须提供将关键字用作普通字的方法，最佳做法不要求强制开发人员了解如何实现。 对于大多数编程语言，语言参考文档都会提供语言所使用的关键字列表。下表提供了某些常用编程语言的参考文档的链接。 缩写和首字母缩写单词 尽量避免使用缩写或首字母缩写词。这类