C#程序编码规范

public class FileStream public class Button public class String
3.6. 接口（Interface源自命名规范和类命名规范相同，唯一区别是
interface IDBCommand; interface IButton;
-6-
接口在名字前加上“I”前缀。例：
3.10. 程序版本号确定规范
主程序的版本号由主版本号+次版本号+Build(Fix 版本号构成)。 主版本号表示程序的重大修改，比如修改或改进了程序的重要功能。 次版本号表示程序的一般修改，比如修改或改进了程序的一般功能。 Fix 版本号表示程序的 Bug 的修改， 以修改的日期缩写表示， 如 2003-11-23 修改的 fix 版本号就是 20031123。 示例：1.2 build(20031123) 表示该程序的主版本号是 1，次版本号为 2，fix 版本号为 20031123
C#程序编码规范

C#程序编码规范
1. 目的
为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立程序编码规范。
2. 范围
适用于所有基于.NET 平台的软件开发工作。
3. 规范内容 3.1. 代码格式
1. 所有的缩进为 4 个空格，使用 的默认设置。 2. 在代码中垂直对齐左括号和右括号。
3.2.2. 类属性注释规范
在类的属性前必须以以下格式编写属性注释：
// //属性说明 // -2-
C#程序编码规范

3.2.3. 方法注释规范
在类的方法声明前必须以以下格式编写注释
/***************************************************** ** 函 数 名: ** 功能描述: ** 输入参数: a - 类型 <说明> ** b - 类型 <说明> ** 输出参数: x - 类型 <说明> ** 返 回 值: 类型 <说明> ** 作 者:<创建人> ** 日 期: ** 修 改:<修改人> ** 日 期: *****************************************************/
private const bool WEB_ENABLESSL_DEFAULT= false;
注： 变量名和常量名最多可以包含 255 个字符，但是，超过 25 到 30 个字符 的名称比较笨拙。此外，要想取一个有实际意义的名称，清楚地表达变量或常量 的用途，25 或 30 个字符应当足够了。
3.5. 类（Class）命名规范
前缀 b sz sb bt n ui l ul f 类型 bool char sbyte byte int uint long ulong float 示例 bEnable; szText sbText btText nText uiText lText ulText fText
-3-
C#程序编码规范
2. 鉴于大多数名称都是通过连接若干单词构造的， 请使用大小写混合的格式以 简化它们的阅读。每个单词的第一个字母都是大写。
-4-
C#程序编码规范

3. 即使对于可能仅出现在几个代码行中的生存期很短的变量， 仍然使用有意义 的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。 4. 在变量名中使用互补对，如 min/max、begin/end 和 open/close。 5. 不要使用原义数字或原义字符串，如 For i = 1 To 7。而是使用命名常数， 如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。
1. 名字应该能够标识事物的特性。 2. 名字尽量不使用缩写，除非它是众所周知的。 3. 名字可以有两个或三个单词组成，但通常不应多于三个。 4. 在名字中，所有单词第一个字母大写。 例如 IsSuperUser，包含 ID 的，ID 全部大写，如 CustomerID。 5. 使用名词或名词短语命名类。 6. 少用缩写。 7. 不要使用下划线字符 (_)。 例：
lab 标签 img 图象(image) pic grd scr lst picture Grid，网格 滚动条 列表框
frm fram
Web 程序 用大写前缀表示类别
Fm 窗口 FmLogin BtnOK CobProduct TxtProductID LabID ImgAA PicXXX GrdProduct
3.2.1. 类注释规范
类开始必须以以下形式书写注释：
/************************************************************** ** 类 编 号：<类编号，可以引用系统设计中的类编号> ** 作 用：<对此类的描述，可以引用系统设计中的描述> ** 作 者：作者中文名 ** 编写日期：<类创建日期，格式：YYYY-MM-DD> ***************************************************************/
-5-
Btn 按钮 Cob 下拉式列表框 Txt Lab Img Pic Grd 文本输入框 标签 图象 picture Grid，网格
C#程序编码规范

Scr 滚动条 Lst 列表框
ScrXXX LstXXX FrmXXX
Frm fram
3.4. 常量命名规范

d b de str x,y att m_ s_
double bool decimal string 坐标 表属性
dText bText deText strText
类成员变量 m_nVal, m_bFlag 类静态成员变量 s_nVal,s_bFlag
补充说明： 针对异常捕获过程中的 Exception 变量命名，在没有冲突的情况下，统一命 名为 e；如果有冲突的情况下，可以重复 e，比如：ee。
if(x==0) { Response.Write("用户编号必须输入！"); }
不允许以下情况：
if(x==0) { Response.Write("用户编号必须输入！"); }
或者：
if(x==0){Response.Write("用户编号必须输入！");}
3. 为了防止在阅读代码时不得不左右滚动源代码编辑器，每行代码或注释在不 得超过一显示屏。 4. 当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清 楚地表示没有后面的行是不完整的。 5. 每一行上放置的语句避免超过一条。 6. 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以 使代码容易阅读。 例：int j = i + k; 而不应写为： int j=i+k;
C#程序编码规范

3.7. 方法（Method）命名规范
和类命名规范相同。
3.8. 命名空间（NameSpace）命名规范
和类命名规范相同。
3.9. 资源命名命名规范
菜单:IDM_XX 或者 CM_XX 位图:IDB_XX 对话框:IDD_XX 字符串:IDS_XX DLGINIT:DIALOG_XX ICON:IDR_XX
3.2. 注释（Comment）规范
注释规范包括：源文件注释规范，类注释规范、类的属性、方法注释规范、 代码间注释。
3.2.1. 源文件注释规范
源文件开始的头注释：
/************************************************** ** 文 件 名: ** Copyright (c) 1998-1999 *********公司技术开发部 ** 文件编号 ** 创 建 人: ** 日 期: ** 修 改 人: ** 日 期: ** 描 述: **************************************************/
-1-
C#程序编码规范

7. 将大的复杂代码节分为较小的、易于理解的模块。 8. 编写 SQL 语句时，对于关键字使用全部大写，对于数据库元素（如表、列 和视图）使用大小写混合。 9. 将每个主要的 SQL 子句放在不同的行上，这样更容易阅读和编辑语句，例 如： SELECT FirstName, LastName FROM Customers WHERE State = 'WA'。
3.2.4. 代码间注释规范
代码间注释：
// //<注释> //
代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必 须能够说明此语句块的作用和实现手段（所用算法等等）。
3.3. 变量（Variable）命名规范 3.3.1. 程序文件(*.cs)中的变量命名规则
1. 命名必须具有一定的实际意义,形式为 xAbcFgh,x 由变量类型确定,Abc、 Fgh 表示连续意义字符串,如果连续意义字符串仅两个,可都大写.如 OK。 具 体例程:
-7-
try { //your code try { //code } catch(Exception ee) { //your code } } catch(Exception e) { //your code }
如果捕获异常不需要作任何处理，则不需要定义 Exception 实例。例：
try { //your code } catch( Exception ) { }
常量名也应当有一定的意义， 格式为 NOUN 或 NOUN_VERB。 常量名均为大写， 字之间用下划线分隔。例：
private const bool WEB_ENABLEPAGECACHE_DEFAULT = true; private const int WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT = 3600;