代码书写标准(推荐).docVIP

C#书写规范准则： 第一章：基本的代码风格 1.1 换行的讲究 1.1.1寻找最佳的断行位置 某两个表达式项之间将其断开 将函数调用的每一个参数都分行书写 将LINQ查询表达式中的每个字句单独写成一行 1.1.2 每行只写一条语句 1.1.3 分行定义变量 将每个变量分行定义将有助于单独注释 1.2 避免代码过于拥挤 1.2.1 使用空行分割代码块 在命名空间引用之后添加空行 在类型的各个成员之间添加空行 用空行分割逻辑块 1.2.2 使用空格降低代码密度 单目运算符与它的操作数之间应紧密相连 在双目 三目运算符的左右两侧分别添加空格 括号（包括小，大，中括号）的内侧应紧靠操作数或者其他运算符，不需要添加额外的空格 不要使用连续的两个或多个空格 1.3 如何缩进 因换行而产生的缩进 函数调用时分行书写参数而引进的缩进 1.4 大括号 1.4.2 空的大括号结构 为未实现的空函数体中添加TODO注释 反转IF条件表达式以避免空的ＩＦ语句 　　　通过注释强调空构造函数 1.5 保持项目文件的条理性 1.5.1 解决方案的结构呼应 1.5.2 代码文件的结构 总体上按照public/internal/protected/private 的访问控制顺序排列 总体上按照构造函数、Finalize函数，字段，属性，方法，事件，委托的类型顺序排列 尽可能将相关性强的成员排列在一起。 私有字段和属性访问器写在一起 通常静态方法在前，实例方法在后。其中国各方法的相互顺序与属性情况类似，既可以根据逻辑关系排列，也可以根据字母顺序排列。对于方法的重载，应放一起。并根据参数的数量由简到繁排列。公开方法之后依次排列的应为事件，委托，对接口的显示实现等。直至给出所有公开成员之后，才是受保护成员与私有成员。 1.5.3 使用#region 标记来隐藏细节 第二章 养成良好的注释习惯 2.1 何时需要注释 2.1.2 对局部变量的说明 对局部变量意义的注释 对局部变量取值范围的注释 对局部变量数量单位的注释 充当代码标题 起到概括作用的标题注释 对判断，循环结构的注释方法 先在前面说明意图，然后在方法体里每个条件再说明具体的条件说明。 注释的格式 2.2.1 单行注释 可以自动成一行，也可以置于行末 2.2.2 多行注释 多行注释主要用于代码文件开头处得版权说明部分，或者是在函数体内的篇幅较长的注释文本。为了突出它的注释性质，我们建议使用这样的格式： /* *这是一段很长很长的注释文本 *这是一个。。 */ 或者 /********************************************** 对萨达打算分的 打三分 ********************************************/ 正确使用XML 文档注释 只要是有可能在其他地方被使用到的类型或成员，都应该带有XML文档注释，比便通过智能感知系统向开发人员提供及时的参考信息。这些必要的位置包括：所有公开的类型，这类型的所有公开的和受保护的成员，这些成员所涉及到得所有参数，返回值，基坑内抛出的异常。 2.3.1 结构与类的XML 文档注释 ///summary /// 表示一副图片 ////summary 我们只需在summary标签中描述该类型的用途 下面的几种描述方式都是较好的。 ——表示。。。。。。。如果该结构或类是真实世界中的某个物体或抽象概念的直接反映，且其名称本身足以让人理解他的主要用途时 ——提供。。。。。。如果该结构或类的功能更倾向于提供某种功能或者服务，或者本身的抽象概念名称无法清晰表达他的主要用途时 ——包含。。。。。有些类型本身并没有包含功能，它的主要目的就是提供对其他一些工具或对象的访问， 2.3.2 属性的XML 文档注释 也只有summary这一个必须的XML文档注释标签。用于描述这个属性的作用 如果属性是即可读又可写的，那么以“获取或设置。。。”的方式进行描述。对于只读属性，则应该使用“获取。。。”的描述方式。 bool类型或枚举类型的属性上，用“获取或设置一个值，该值表示。。。。。”方式进行描述 2.3.3 方法的XML 文档注释 不但需要用summary标签添加总体描述，还要用param标签为每个参