C#代码编写规范

 

 

一、   类、接口、结构命名规范

用pascal规则来命名结构和类。

例如：

public class TextBox

{

   public void DataBind() 

   {

   }

}

如果是接口请在前面加上 I。

 

二、   方法命名规范

用pascal规则来命名。

void SayHello(string name)

 

三、   变量（常量）命名规范

 

常量与变量命名规范相同。

1、          全局变量命名规范

用pascal规则来命名。

2、          局部及成员变量命名规范

用camel规则来命名。

 

四、   控件命名规范

前缀与 pasca 结合的命名规范

前缀表如下：

窗口：Fm

按钮： Btn

下拉列表： Cob

文本输入框： Txt

标签： Lab

图像： Img

网格： Grd

滚动条： Scr

列表框： Lst

菜单： Mnu

导航条： Nav

例如：FmLogin 表示登录窗口。

 

五、   名称空间命名规范

用pascal规则来命名。

 

六、   资源命名规范

菜单：IDM_XX

位图：IDB_XX

对话框：IDD_XX

字符串：IDS_XX

图标：IDR_XX

 

七、   编码格式规范

1、          VS 默认格式右缩进4个空格。

2、          同一层次括号垂直对齐。

3、          每行代码和注释不应产生横向滚屏。

4、          每行代码不能多于一条。

5、          预算符前面应加入空格。

6、          SQL 中所有关键字全部大写。

7、          每个主要的SQL子句放在不同行。

 

八、   注释规范

1、          代码文件cs 头部：

/*************************************************

** 文件名

**Copyright(c) 2006-2007 开发团队

** 创建人：

** 日 期：

** 修改人：

** 日 期：

** 描 述：

****************************************************/

2、          类注释规范

/*************************************************

** 类编号

** 作 者

** 作 用：

** 编写日期：

****************************************************/

3、          类属性注释规范

//

// 属性说明

//

4、          方法注释规范

/*************************************************

** 方法名

** 输入参数：a 类型 说明

            b 类型 说明

** 输出参数：c 类型 说明

** 返回值：d 类型 说明

** 作 者：

** 日 期：

** 修改人：

** 日  期：

** 描  述：

****************************************************/

 

5、          代码间注释规范

//

// 注释

//

 

附：

Pascal 大小写形式－所有单词第一个字母大写，其他字母小写。
Camel   大小写形式－除了第一个单词，所有单词第一个字母大写，其他字母小写。