C#编码规范

太阳不下山

一、代码格式
在编写代码的过程中，代码格式方面建议遵守一下规则。
（1）通常情况下，代码缩进为4个空格，这是Visual Studio 2005的默认设置。
（2）在代码中垂直对齐同一层次的左括号和右括号。
（3）为了防止在阅读代码时左右滚动源代码编辑器，每行代码或注释不得超过一个显示屏。
（4）当一行被分为几行时，需要将串联运算符放在每一行的末尾。
（5）每一行上放置的语句避免超过一条。
（6）在大多数运算符之前和之后使用空格，这样做是不会改变代码意图的，却可以使代码更加容易阅读。
（7）将大的复杂代码节分为较小的、易于理解的模块。
（8）编写SQL语句时，关键字全部使用大写，数据库元素（如表、列和视图）使用大小写混合。
（9）将每个主要的SQL子句放在不同的行上，这样更容易阅读和编辑语句。
示例代码如下：
SELECT FirstName,LastName
FROM Customers
WHERE State = ‘CHN’
二、注释规范
注释规范包括：源文件注释规范、类注释规范、类的属性和方法注释规范、代码间注释。
1。源文件注释规范
建议的源文件头部注释示例如下所示。
/*****************************************************
** 文 件 名：
** Copyright (c) 2005-2006 ********软件项目开发部门
** 文件编号：
** 创 建 人：
** 日    期：
** 修 改 人：
** 日    期：
** 描    述：
********************************************************/
2。类注释规范
类开始部分必须以如下形式书写注释。
/**********************************************************
** 类 编 号：<类编号可以引用系统设计中的类编号>
** 作    用：<对此类的描述，可以引用系统设计中的描述>
** 作    者：作者中文名
** 编写日期：<类创建口期，格式：YYYY-MM-DD>
**********************************************************/
3。类属性注释规范
在类的属性前必须以如下格式编写属性注释。
//
//属性说明
//
4。方法注释规范
在类的方法声明前必须以如下格式编写注释。
/*****************************************************
** 函 数 名：
** 功能描述：
** 输入参数：a － 类型 <说明>
**                 b － 类型 <说明>
** 输出参数：x － 类型 <说明>
** 返 回 值：－ 类型 <说明>
** 作    者：作者中文名
** 日    期：
** 修 改 人：<修改人>
** 日    期：
********************************************************/
5。代码间注释规范
代码间注释应遵从以下规范。
//
//<注释>
//
代码中遇到语句块时，例如，if，for，foreach必须添加注释。添加的注释要能够说明此语句块的作用和实现手段。
三、类命名规范
（1）名字应该能够标识事物的特性。
（2）名字尽量不使用缩写，除非是众所周知的。
（3）名字可以由两个或三个单词组成，通常不应多于三个。
（4）在名字中，所有单词第一个字母大写。
（5）使用名词或名词短语命名类。
（6）少用缩写。
（7）不要使用下划线字符（_）。
四、接口命名规范
和类命名规范相同，唯一区别是接口在名字前加上“I”前缀。
五、方法命名规范
和类命名规范相同。
六、名字空间命名规范
和类命名规范相同。
七、程序版本号确定规范
主程序的版本号由主版本号十次版本号+Build（Fix版本号）构成。主版本号表示程序的重大修改，例如，修改或改进了程序的重要功能。次版本号表示程序的一般修改，例如，修改或了程序的一般功能。Fix议版本号表示程序Bug的修改，以修改的日期缩写表示，如2006-8-20修改的Fix版本号就是20060820。举例说明，程序版本号为1.2bulid（2060820），表示该程序的主号是1，次版本号为2，Fix版本号为20060820。