基于.NET项目的代码书写规范要求书

本文为下半年为一项目撰写的简要代码书写规范，不尽详尽，但仍有参考价值。但是代码书写规范更重要的是项目组内组员的意识性的提高，根据此项目到目前为止的状况，就此简单规范的实现情况并不乐观，代码中仍有五花八门各个流派的风格，此问题系软件项目组管理中的不完善所致，在此并不研究此问题。

第一章 主体命名规范

一、外挂服务命名规范

1) 服务项目命名

所有服务项目名使用ESrv（注意大小写）[/b]开头，第五位字母开始自订义，但是第五位字母必须大写。比如ESrvDemo1，其中Demo1为自定义名称。[/b]

二、类成员访问权限规范

所有类成员要严格的按照成员的使用性质，设置它们的访问修饰符，修饰符的意义如下：

声明的可访问性[/b]	意义[/b]
public	访问不受限制。
protected	访问仅限于包含类或从包含类派生的类型。
internal	访问仅限于当前程序集。
protected internal	访问仅限于从包含类派生的当前程序集或类型。
private	访问仅限于包含类型。

第二章 代码书写规范

一、代码注释规范

1) .cs文件的注释

所有.cs文件开头都要加上注释，写明文件创建时间、作者、用途概述等

格式如下:

//********************************************************[/b]

//新增日期: 2004.7.19[/b]

//作 者: XXX [/b]

//內容说明:　XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX[/b]

//********************************************************[/b]

2) 函数过程注释

所有的函数体开头都要加上注释，所以注释使用.NET注释规范，如下格式：

/// <summary>[/b]

/// 构造函数[/b]

/// </summary>[/b]

/// <param name="is_xxx1">示例参数1</param>[/b]

/// <param name="is_xxx2">示例参数2</param>[/b]

public UpgradeThread(string is_xxx1, string is_xxx2)[/b]

{[/b]

//…[/b]

}[/b]

3) 常量变量注释

所有的常量变量，无论是全局还是局部使用的，凡是对代码整体起到关键性做用的都需要加上注释。如下示例：

/// <summary>[/b]

/// 当前线程指向的备份文件本地保存路径[/b]

/// </summary>[/b]

public string StorePath = "";[/b]

4) 代码修改注释

当开发者维护以前的程序代码时，需要在修改处的开始及结尾，加上自己的注释信息，格式如下:

//BEGIN 2004-7-19 Jayson　修正了XXX问题[/b]

略…[/b]

//END 2004-7-19 Jayson[/b]

二、代码排版规范

1) 语句结构

为保证语句结构的清晰和程序的可读性，在编写软件程序时应注意以下几个方面的问题：

l 在一行内只写一条语句，并采用空格、空行和移行保证清楚的视觉效果。

l 每一个嵌套的函数块，使用一个TAB缩进，大括号必须放在条件语句的下一行，单独成一行，便于匹对。

如，有一段程序如下：
for(int i=0; i<10; i++){Console.WriteLine(“xxxxx”)}[/b]

应该写为:[/b]

for(int i=0; i<10; i++)[/b]

{[/b]

Console.WriteLine(“xxxxx”)[/b]

}[/b]

2) 代码书写格式规范

l 文件之中不得存在无规则的空行，比如说连续十个空行。一般来讲函数与函数之间的空行为2-3行；

l 在函数体内部，在逻辑上独立的两个函数块可适当空行，一般为1-2行。

l 每行长度尽量避免超过屏幕宽度，应不超过80个字符。

l 尽量用公共过程或子程序去代替重复的功能代码段。

l 使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。如将 x=a*b/c*d 写成 x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d)。

l 避免采用过于复杂的条件测试。

l 避免过多的循环嵌套和条件嵌套。

l 一个函数不要超过200行。一个文件应避免超过2000行。

l 避免使用goto语句。

l 避免采用多赋值语句，如x = y = z;

三、结构定义规范

1) 命名规则（定义在iTradeDefine 命名空间里面)：

l 用大写字母表示

l TAG_XXXX 以TAG大头，下划线后面定义具体结构的名称

2) 示例：

l public struct TAG_ALLMESSAGE

四、枚举类型定义规范

1) 命名规则:

l 用大写字母表示

l EU_XXXX以EU 打头，下划线后面定义类型名称

2) 示例:

l public enum EU_MESSAGE

五、常量定义规范

1) 全局使用常量(定义在iTradeDefine 命名空间里面)

l 示例：

n public const bool G_TRANS_FALSE = false;

l 常量定义规范

n 大写字母命名

n G_XXX_YYY G表示全局，XXX标识常量用途，YYY标识具体的值

2) 局部使用常量（定义在每个Class 的前面）

l 示例：

n public const int L_PRIORITY_LOWEST = 0

l 常量定义规范

n 大写字母命名

n L_XXX_YYY L表示局部，XXX标识常量用途，YYY标识具体的值

六、变量定义规范

1) 变量定义原则

变量定义的基本原则是：变量名＝属性＋类型＋对象描述+自定义。

每一个变量定义尽量在函数、过程的开始处就进行定义，尽量避免在代码中不规则的穿插定义。

2) 变量属性命名表

属性[/b]	对应标识符[/b]
全局变量	g_
常量	c_
类成员变量	m_
局部变量	无属性前缀

3) 变量类型命名表

类型[/b]	对应标识符[/b]
句柄	h
布尔型	b
浮点型	f
无符号	u
字符串	sz
数字型	i

4) 变量类型描述表

类型[/b]	对应标识符[/b]
初始化	Init
临时变量	Tmp
目的对象	Dst
源对象	Src
窗口	Wnd

5) 示例

定义一个全局的字符串型的自定义变量：g_szDemo[/b]。

七、函数命名规范

1) 避免在函数名中使用“_”。

2) 同一组功能的函数定义一个功能简写，做为该组函数的前缀。

3) XxxYyyZzz Xxx表示该函数的前缀 Yyy 标识函数的动作 Zzz 标识函数的对象

4) 示例：DelegateGetBody()

八、函数出参入参返回值规范

1) 函数的输入输出参数

函数入参使用前缀“ix”开头，出参用“ox”其后根据变量定义中“类型＋对象描述+自定义”的原则来完成。

示例：string isQuePath 入参 ref iTFParam otQueBody 出参

2) 函数返回值

避免使用结构体等复杂类型

使用bool类型：该函数只需要获得成功或者失败的返回信息时候

使用int 类型：错误代码用负数表示，成功返回0