博客园  :: 首页  :: 新随笔  :: 联系 :: 订阅 订阅  :: 管理

c#编码规范

Posted on 2010-11-03 15:29  gczhao  阅读(281)  评论(0编辑  收藏  举报

本文转自http://blog.csdn.net/usernamegaorn/archive/2007/10/20/1834250.aspx

 

 

1 命名规约

1.1 数据库对象命名规约

1.1.1 表名

均采用Tab-前缀+单数英文名词表示,不加空格,每个词的首字母大写。

表示单个实体的表名:TabXxxx——XXXX为实体英文单词,例如:员工信息表——TabEmployee;

表示两个实体关系的表名:TabXxYy——XxYy为实体汉语拼音声母字母,例如:项目课程信息表——TabProjectCourse。

1.1.2 视图名

均采用View-前缀+视图主要内容或基表名称构成,其他约定同表名。

1.1.3 存储过程名

均采用Proc-前缀+存储过程主要用途名称构成,其他约定同表名。

1.2 WinForms窗体与控件对象命名规约

1.2.1 窗体名:均以frm-为前缀,采用英文单词表示,每个词的首字母大写。

临时窗体名:frm+使用者+用途。例如:前台登录窗体——frmWaiterLogin。

主界面窗体名:frmMain+使用者。例如:前台主界面窗体——frmMainWaiter。

1.2.2 控件名:均以前缀+用途或内容的英文单词表示,每个词的首字母大写。

TextBox控件:前缀为txt-,例如:用于输入用户名的TextBox——txtUserName。

Label控件:前缀为lbl-。

Button控件:前缀为btn-。

ComboBox控件:前缀为cmb-。

CheckBox控件:前缀为chk-。

RadioButton控件:前缀为rad-。

Panel控件:前缀为pnl-。

DataGrid控件:前缀为grd-。

MainMenu控件:前缀为mmu-。

ContextMenu控件:前缀为cmu-。

子菜单项:mu+菜单项名+子菜单项用途,例如:“文件”菜单中的“退出”项——muFileExit。

1.3 C# 类名与变量名命名规约

1.3.1 类名:均以Cls-为前缀。

1.3.2 类数据成员名:私有变量均以下划线“_”为前缀,首字母小写。

1.3.3 变量名:

1.3.3.1 基本类型变量以变量类型的缩写为前缀,首字母小写。

int型:前缀为i-。

long型:前缀为l-。

double型:前缀为d-。

float型:前缀为f-。

bool型:前缀为b-。

string型:前缀为str-。

1.3.3.2 系统引用类型变量以变量类型的缩写为前缀,首字母小写。

object型:前缀为obj-。

Array型:前缀为arr-。

ArrayList型:前缀为als-。

Hashtable型:前缀为ht-。

DateTime型:前缀为dtm-。

DataSet型:前缀为ds-。

DataTable型:前缀为dtb-。

DataView型:前缀为dvw-。

DataAdapter型:前缀为da-。

DataReader型:前缀为dr-。

1.3.4 函数或方法名:

主要用途的英文单词组合,首字母大写。

1.3.5 属性或索引名:

主要内容的英文单词组合,首字母大写。

1.4 报表名:

rpt+主要内容的英文单词。

2 代码编写规约

2.1 SQL语句的书写规约

例: strSQL = “SELECT * ”;

strSQL += “FROM tablename ”;

strSQL += “WHERE tablename”;

2.2 C# 代码的书写规约

按.NET推荐的编码风格编写,使用缩进与空行。

对代码段、方法的参数和各变量的用途进行注释。

对数据库操作、IO操作、类型转换等进行异常处理。
 


本文来自CSDN博客,转载请标明出处:http://blog.csdn.net/usernamegaorn/archive/2007/10/20/1834250.aspx