某公司NET编程规范.docVIP

.NET 编程规范 [ 参考资料 ] Framework Design Guidelines 及 The Art of Building a Reusable Class Library (PowerPoint for PDC05)Krzysztof Cwalina，Brad Abrams 合著（两人系微软公司CLR项目经理及主管） Programming .NET Components (2nd Edition) 及 IDesign C# Coding Standard (Version 2.32)Juval Lowy，IDesign 创始人、微软公司硅谷区域总监 [ 通用风格约定 ] A. 花括号 - 只有一条语句的代码块和花括号可以考虑写在同一行中。属性的访问方法经常这样使用。 get{ return foo; } set{ foo = value; } - 使右花括号独占一行，除非后面是 else，else if 或 while。 do { DoSomething(); } while (someCondition); - 左花括号始终放在一个新行中，独占该行。 - 避免省略花括号。即使只有一条语句仍应该使用花括号，以增加代码的易读性和可维护性。 if (someCondition) { DoSomething(); } - 极少数情况下可以省略。 一是在仅有的一条语句后不可能再添加语句，像是 if (expression) throw Exception(); 二是 case 语句。因为 break 的存在，一般不需要添加花括号来表示代码块。 B. 空格 - 要在左花括号之后和右花括号之前加一个空格。 public int Foo { get{ return foo; } } - 要在形式参数之间的逗号后加一个空格。 public void Foo(char bar, int x, int y) - 避免在实际参数之间加空格。避免在左圆括号之后或右圆括号之前加空格。 最好如此：Foo(myChar,0,1) - 不要在成员的名字和左圆括号之间加空格。 Foo() Foo () - 不要在左方括号之后或右方括号之前加空格。 dataArray[index] dataArray[ index ] - 不要在一元操作之前或之后加空格。 if(!y){...} if(! y){...} - 不要在空行中或语句末尾加无用的空格。 C. 缩进 - 要用连续4个空格来进行缩进。 - 不要用制表符（Tab）来进行缩进。 - 要对使用花括号的代码块中的内容进行缩进。 - 对 case 代码块也要进行缩进。 D. 注释 - 在关键语句处进行注释。对代码块的行为进行注释。 - 不要用注释来描述一些对任何人都显而易见的事。 - 避免使用C风格的块注释语法（/* ... */），应使用单行注释（//）。 - 不要把注释放在行尾，除非注释非常短。 不好的例子： public class ArrayList { private int count; // -1 indicates uninitialized array } - 注释文本的“//”要和你所注释的代码对齐。 // This is the comment. myResult = MyClass.MyMethod(); E. XML 注释 - 要使用 XMLDoc 而非普通注释对方法进行注释。 - 对常用的接口和公有类型的成员，尽量使用 XMLDoc 进行注释。 - 最常用的 XMLDoc 标记： /// summary被注释的C#对象的概要介绍。/summary /// remarks对象的详细说明。/remarks /// value对 Property 注释时使用，把对其值的说明放在这里。/value /// param name=s对 Method 注释时使用，描述名为s的参数。/param /// returns在这里描述 Method 的返回值表示什么。/returns - 生成的 XML 文档可以帮助编译 CHM。 - 更多有关 XML Documentation 的内容请参见 MSDN： /zh-cn/library/b2s063f7.asp