4、 申明
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) {
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;
} } }
5、 命名规范
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 Pascal Pascal Pascal Pascal Pascal Pascal AppDomain ErrorLevel FatalError ValueChange WebException :注意 总是以 Exception 后缀结尾。 RedValue IDisposable :注意 总是以 I 前缀开始。 ToString System.Drawing BackColor RedValue 注意 很少使用。属性优于使用公共实例字段。 redValue :注意 很少使用。属性优于使用受保护的实例字段。 redValue typeName backColor 示例 受保护的实例字段 私有的实例字段 参数 方法内的变量
Camel Camel Camel Camel 5.3 缩写
为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则:
1、 不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用
GetWindow,而不要使用 GetWin。
2、 不要使用计算机领域中未被普遍接受的缩写。