第四章 申明
4.1
每行声明数
一行只建议作一个声明，并按字母顺序排列。如
int level; //推荐 int size; //推荐 int x, y; //不推荐
4.2
初始化
建议在变量声明时就对其做初始化。
4.3
位置
变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。如
void MyMethod() {
int int1 = 0; // beginning of method block
if (condition) {
int int2 = 0; // beginning of \ ... } }
不过也有一个例外
for (int i = 0; i < maxLoops; i++) { ... }
应避免不同层次间的变量重名，如
int count; ...
void MyMethod() {
if (condition) {
16
int count = 0; // 避免 ... } ...
}
4.4 类和接口的声明
1 在方法名与其后的左括号间没有任何空格。
2 左花括号 “{” 出现在声明的下行并与之对齐，单独成行。 3 方法间用一个空行隔开。
4.5
字段的声明
不要使用是 public 或 protected 的实例字段。如果避免将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因是在维护二进制兼容性时字段不能被更改为属性。考虑为字段提供 get 和set 属性访问器，而不是使它们成为公共的。 get 和 set 属性访问器中可执行代码的存在使得可以进行后续改进，如在使用属性或者得到属性更改通知时根据需要创建对象。下面的代码示例阐释带有get 和 set 属性访问器的私有实例字段的正确使用。 示例：
public class Control: Component {
private int handle; public int Handle {
get {
return handle; } }
}
17
第五章 命名规范
5.1
命名概述
名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用 GetNextStudent()，而不是 GetNextArrayElement()。 命名原则是：
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称，如方面名 AnalyzeThis()，或者属性名 xxK8。这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的，如 Book.BookTitle。而是应该使用 Book.Title。 3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。 4、在变量名中使用互补对，如 min/max、begin/end 和 open/close。
5、布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFound。
6、在命名状态变量时，避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag，而是使用更具描述性的名称，如 documentFormatType。 （此项只供参考）
7、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。 可能的情况下，尽量不要使用原义数字或原义字符串，如 For i = 1 To 7。而是使用命名常数，如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。
5.2
大写
大小写规则
标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：
System.IO
System.Web.UI
下表汇总了大写规则，并提供了不同类型的标识符的示例。
标识符 类 枚举类型 枚举值 事件 异常类
Pascal Pascal Pascal Pascal Pascal
大小写 AppDomain ErrorLevel FatalError ValueChange WebException
注意 总是以 Exception 后缀结尾。
18
示例
只读的静态字段 接口
Pascal Pascal
RedValue IDisposable
注意 总是以 I 前缀开始。
方法 命名空间 属性
公共实例字段
Pascal Pascal Pascal Pascal
ToString System.Drawing BackColor RedValue
注意 很少使用。属性优于使用公共实例字段。
受保护的实例字段 Camel
redValue
注意 很少使用。属性优于使用受保护的实例字段。
私有的实例字段 参数
Camel Camel
redValue typeName
方法内的变量 Camel backColor
5.3 缩写
为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：
1 不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用 GetWindow，而不要使用 GetWin。 2 不要使用计算机领域中未被普遍接受的缩写。
3 在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 缩 写，用 OLAP 作为 On-line Analytical Processing 的缩写。
4在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如，使用 HtmlButton 或 HTMLButton。但是，应当大写仅有两个字符的缩写，如，System.IO，而不是 System.Io。
5 不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请 使用Camel 大小写，虽然这和单词的标准缩写相冲突。
5.4
命名空间
CompanyName.ProjectName.ChildProjectame. Module
1、命名命名空间时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。 例如：
Namespace 56HUI.CRM.OA.OADAL
2、命名空间使用Pascal大小写，用逗号分隔开。
3、TechnologyName 指的是该项目的英文缩写，或软件名。
4、命名空间和类不能使用同样的名字。例如，有一个类被命名为Debug后，就不要再使用Debug作为一个名称空间名。
类
19
1、使用 Pascal 大小写。
2、用名词或名词短语命名类。
3、使用全称避免缩写，除非缩写已是一种公认的约定，如URL、HTML
4 、不要使用类型前缀，如在类名称上对类使用 C 前缀。例如，使用类名称 FileStream，而不是 CFileStream。
5 、不要使用下划线字符 (_)。
6 、有时候需要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是作为类名称组成部分的整个单词的第一个字母，这便是适当的。例如，类名称 IdentityStore 是适当的。在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因ApplicationException 是一种Exception。请在应用该规则时进行合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一部分将使名称不必要地加长。
public class FileStream public class Button
public class String
5.5 接口
以下规则概述接口的命名指南：
1、用名词或名词短语，或者描述行为的形容词命名接口。例如，接口名称 IComponent 使用描述性
名词。接口名称 ICustomAttributeProvider 使用名词短语。名称 IPersistable 使用形容词。 2、使用 Pascal 大小写。 3、少用缩写。
4、给接口名称加上字母 I 前缀，以指示该类型为接口。在定义类/接口对（其中类是接口的标准
实现）时使用相似的名称。两个名称的区别应该只是接口名称上有字母 I 前缀。
5、不要使用下划线字符 (_)。
6、当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处
只是接口名前有一个I前缀。
以下是正确命名的接口的示例。
public interface IServiceProvider public interface IFormatable
以下代码示例阐释如何定义 IComponent 接口及其标准实现 Component 类。
public interface IComponent {
// Implementation code goes here. }
public class Component: IComponent
20
百度搜索“77cn”或“免费范文网”即可找到本站免费阅读全部范文。收藏本站方便下次阅读，免费范文网，提供经典小说教育文库Csharp编程规范(4)在线全文阅读。
相关推荐：