DotNET编程规范(4)

DotNET编程规范

2.2、函数、属性、类等注释

请使用///三斜线注释，这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。以protected，protected Internal，public声明的定义注释请都以这样命名方法。 例如：

/// <summary>

/// 用于从ERP系统中捞出产品信息的类 /// </summary>

class ProductTypeCollector { … }

2.3、逻辑点注释

在我们认为逻辑性较强的地方加入注释，说明这段程序的逻辑是怎样的，以方便我们自己后来的理解以及其他人的理解，并且这样还可以在一定程度上排除BUG。在注释中写明我们的逻辑思想，对照程序，判断程序是否符合我们的初衷，如果不是，则我们应该仔细思考耀修改的是注释还是程序了…

3、排版

我的排版原则与建议：

1、 每行语句至少占一行，如果语句过长（超过一屏），则该语句断为两行显示；

2、 把相似的内容放在一起，比如数据成员、属性、方法、事件等，并适当的使用

#region…#endregion，我最喜欢把机器生成的代码都放在一个#region里面，比如在编写程序时，对应自动产生的控件定义，我常用#region Automatic Generated Web Components … #endregion把他们框住

3、 使用空格，

（1） 目操作符的前后加空格(+, =, && 等) （2） 单目操作符前后不加空格(!, ++, ~ 等) （3） 逗号、分号只在后面加空格

4、 使用空行，在一段功能代码、或者函数、属性之间插入空行，这样会很直观。