C#命名规范
1、目的
为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护，特制定此规范。
2、范围
本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
3、注释规范
3.1
概述
a)
注释要求英文及英文的标点符号。
b)
注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。
c)
每行注释的最大长度为100个字符。
d)
将注释与注释分隔符用一个空格分开。
e)
不允许给注释加外框。
f)
编码的同时书写注释。
g)
重要变量必须有注释。
h)
变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个“Tab”键。
如：int m_iLevel,m_iCount;
// m_iLevel ....tree level
// m_iCount ....count of tree items
string m_strSql; //SQL
i)
典型算法必须有注释。
j)
在循环和逻辑分支地方的上行必须就近书写注释。
k)
程序段或语句的注释在程序段或语句的上一行
l)
在代码交付之前，必须删掉临时的或无关的注释。
m)
为便于阅读代码，每行代码的长度应少于100个字符。
3.2
自建代码文件注释
对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：
/******************************************************
FileName:
Copyright (c) 2004-xxxx *********公司技术开发部
Writer:
create Date:
Rewriter:
Rewrite Date:
Impact:
Main Content（Function Name、parameters、returns）
******************************************************/
3.3
模块（类）注释
模块开始必须以以下形式书写模块注释：
/// <summary>
/// Module ID：<模块编号，可以引用系统设计中的模块编号>
/// Depiction：<对此类的描述，可以引用系统设计中的描述>
/// Author：作者中文名
/// Create Date：<模块创建日期，格式：YYYY-MM-DD>
/// </summary>
如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：
/// Rewriter：Rewrite Date：<修改日期，格式：YYYY-MM-DD> Start1：
/* 原代码内容*/
/// End1：
将原代码内容注释掉，然后添加新代码使用以下注释：
/// Added by： Add date：<添加日期，格式：YYYY-MM-DD> Start2：
新代码内容
/// End2：
如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释：
/// <summary>
/// Log ID：<Log编号,从1开始一次增加>
/// depiction：<对此修改的描述>
/// Writer：修改者中文名
/// Rewrite Date：<模块修改日期，格式：YYYY-MM-DD>
/// </summary>
3.4
类属性注释
在类的属性必须以以下格式编写属性注释：
///
<summary>
/// <Properties depiction>
/// </summary>
3.5
方法注释
在类的方法声明前必须以以下格式编写注释
///
<summary>
///
depiction：<对该方法的说明>
///
</summary>
///
<param name="<参数名称>"><参数说明></param>
///
<returns>
/// <对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>
///
</returns>
///
Writer：作者中文名
/// Create Date：<方法创建日期，格式：YYYY-MM-DD>
3.6
代码间注释
代码间注释分为单行注释和多行注释：
单行注释：
//<单行注释>
多行注释：
/*多行注释1
多行注释2
多行注释3*/
代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。
