项目编码规范
- 格式：doc
- 大小：134.50 KB
- 文档页数：11
表命名的十个需要注意的地方
存储 过程
sp_ 单个表直接用表名，并加功能，大小写均可（Add,Edit,Del,Query,Report,Validate
up_
等）
proc_
视图
触发 器
vw_ trg_
vw_直接的内容，一般是用于查询 Query 和报表 Report 两种情形
方法一：trg_表名_方法名_[之前之后等] 比如：trg_User_Info_Insert 方法二：
频率下不得超过一显示屏 4) 每一行上放置的语句避免超过一条。 5) 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图 却可以使代码
容易阅读。 例： int j = i + k; 而不应写为 int j=i+k; 6) 将大的复杂代码节分为较小的、易于理解的模块。 7) 相同功能的代码段用＃region 折叠起来，在阅读时比较简洁和易于理解 例： #region 代码段说明 #endregion
触发器分为行级 Row【R】和语句级 Statement[【S】， 又分为 after【A】，before【B】，instead of【I】，
方法又有三种 Insert【I】,Update【U】,Detele【D】， 所以：如:trg_User_Info_RBI（代表语句级,之前,插入操作）,有点专业,不知道
写法 3：seq_User_Info_UI_ID（表名加字段名）
trans_ crs_
@面向用户或者应用名，这个以用户名或者应用名加后缀组成 数据表空间以用户名+_+data 命名 索引表空间以用户名+_+idx 命名
专用临时表空间以用户名+_+tmp 命名 专用回滚段表空间以用户名+_+rbs 命名
1.5 方法
1) 使用动词或动词短语命名方法。 2) 采用 Pascal case，所有单词第一个字母大写。 3) 方法中的参数命名采用 Camel casing,所有单词第一个字母大写，除了首字母小写。
1.6 属性
1) 使用名词或名词短语命名 2) 采用 Pascal case，所有单词第一个字母大写 3) 少用缩写 4) 不要使用下划线字符( _ )
特殊处理： @LOB 段数据专用表空间后面再加_lobs 命名
总则：不管你用什么命名方法，所有的命名规则一定要统一，不要一会儿中文拼音一会 儿英文等等。 1、采用英文单词或英文短语（包括缩写）作为名称，不能使用无意义的字符或汉语拼
音。
2、每个数据库对象表，视图，字段，存储过程，不要用任何数据库的关键词作为名称。
凡是能写注释的地方，应该写上注释பைடு நூலகம்以便查看。
3、名称应该清晰明了，能够准确表达事物的含义，最好可读，遵循“见名知意”的原则。
1.11 注释
注释规范包括：类注释规范、类的属性、方法注释规范、代码间注释规范
1.11.1 类注释规范
类开始必须以以下形式书写类注释： ///<summary> ///类的描述: ///作者： ///创建时间：<格式：YYYY-MM-DD> ///</summary>
1.11.2 类属性注释规范
在类的属性必须以以下格式编写属性注释： /// <summary> /// 属性说明: /// </summary>
fk_
fk_从表名字段_主表名字段。这个推荐
idx_
idx_表名_字段名(一个或多个)【可以在其后加 U 或者 C,规则同触犯器】 推荐使用：idx_字段名
一是唯一 Unique【U】与非唯一 NonUnique【N】 一是聚集 Cluster【C】与非聚集 NonCluster【N】
ck_
1. 默认约束：df_表名_列名，df_列名
bln byt char dbl flt int lng obj str
前缀 coll dt ds drd dr dc hs xml xr
2) 类的私有变量，在遵循第一条规则后，在其前加“m_”前缀。 例: public class Hello {
private string m_strName; public string Name {
函数 主键
外键 索引
约束
命名规则的人看不明白。
fn_ fn_功能名称。一些是具体的操作函数，比如字符串处理,fn_SplitStr(参数)处理字符
f_
串，如果与模块相关，则 fn_模块名称_具体方法
pk_
pk_表名[或缩写]_列名
简洁的写法：
写法一：pk_表名，
写法二：pk_列名，因为列名设计时已经包含表的含义
3 SourceSafe 使用规范
代码维护一律使用 内嵌的集成方式，不要使用 VSS 客户端工具（客户端工具仅用来 维护文档版本）。
注意： 必须安装 2003 安装程序内带的 VSS 版本（6.0d），才能与 环境集成。 如果已安装其它早期版本，请先卸载再安装新版本。
1.7 变量
1) 变量名称 = 变量的前缀 + 代表变量含意的英文单词或单词缩写。
常用变量类型的前缀命名规则，定义如下：
类型
前缀
bool byte char double float integer long object string 常用对象: 类型 Collection DateTime DataSet DataReader DataRow DataColumn Hashtable XmlDom XmlReader
4、对长度也要有限制，最好不要超过 30 个字符，在 PD 设置生成时，部分数据库对
象会自动截取到 30 位。
5、所有名称的字符范围为：A-Z, a-z, 0-9 和_(下划线)。不允许使用其他字符作为
名称。
6、注释分单行和双行，在数据库对象如函数，存储过程，视图等，都需要在页头添加
数据 库对 象
表
1.11.3 方法注释规范
在类的方法声明前必须以以下格式编写注释 /// <summary> /// 说明：<对该方法的说明> /// </summary> /// <param name="<参数名称>"><参数说明></param> /// <returns> ///<对方法返回值的说明> /// </returns>
3.1 创建项目
第一个创建项目的人应在 2003 环境下的菜单中选择“文件”—〉“源代码管理 器”—〉“将选定项目添加到源代码管理器”（注意：不要选择“将解决方案添加到源代码管 理器”）。
下图是一个 Project 的资源管理视图，其中 bin、obj 两个灰色的目录是 2003 自动生 成的临时文件夹，用来保存编译过程中的临时文件，不应上传到 SourceSafe 上，否则会因为指 读属性影响本地编译结果。
前缀
命名说明
写法一：模块名_具体功能实体名，如用户角色表 User_Role 等， 写法二：直接写成 UserRole，不用"_"来区分，看习惯和所用数据库。
表名缩 列名 写_
写法：表名缩写_具体内容 如用户角色表 User_Role 的名称：UR_Name， 如果是单个的表名，比如区域表 Area,则可以写成 Area_ID。
1.11.4 代码间注释规范
代码间注释分为单行注释和多行注释： 单行注释：
//<单行注释> 多行注释：
/* 多行注释 1 多行注释 2 多行注释 3
*/
2 C#代码格式规范
1) 所有的缩进为 4 个空格，使用 的默认设置。 2) 在代码中垂直对齐左括号和右括号。(需讨论) 例： if(x == 0) {
命名
Btn Chk Cmb Dtb Grb Lbl Lkp Num Pnl Pgb Rad Txt Memo Tvw
DataGrid DataList Image DropDownList
Grid List Img Drp
1.10 数据集命名规范
1) 普通数据集命名以 Ds 开头 2) 作为查询参数的数据集命名以 DsQuery 开头，表名以 QUERY_为前缀 3) 元素的所有字母大写，各字母以下划线“_”分割 4) 专用名词建议使用习惯缩写 5) 与后台交互的数据集不允许使用属性
Response.Write("用户编号必须输入！"); } 不允许以下情况： if(x==0) {
Response.Write("用户编号必须输入！"); } 或者： if(x==0){ Response.Write("用户编号必须输入！");} 3) 为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在 1024*800 的显示
1.8 常量
1) 常量的名字应该都大写，并且指出完整含义，单词之间用下划线（_）分隔。 例： const int PAGE_COUNT = 10;
1.9 控件
前台系统开发时，只能使用下面列出的控件，又不能满足要求请先和模块负责人联系。讨 论通过后才可使用，规范修改前严禁使用未列出的控件。Framework 有提供相应控件的，不得 使用.Net 标准控件
控件命名 = Window 控件缩写前缀 + 变量名
控件类型
Button CheckBox ComboBox DateTimeBox GroupBox Label LookupBox NumericBox Panel ProgressBar RadioButton TextBox MemoEdit TreeView
get {
return m_strName; } }
存储 过程
sp_ 单个表直接用表名，并加功能，大小写均可（Add,Edit,Del,Query,Report,Validate
up_
等）
proc_
视图
触发 器
vw_ trg_
vw_直接的内容，一般是用于查询 Query 和报表 Report 两种情形
方法一：trg_表名_方法名_[之前之后等] 比如：trg_User_Info_Insert 方法二：
频率下不得超过一显示屏 4) 每一行上放置的语句避免超过一条。 5) 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图 却可以使代码
容易阅读。 例： int j = i + k; 而不应写为 int j=i+k; 6) 将大的复杂代码节分为较小的、易于理解的模块。 7) 相同功能的代码段用＃region 折叠起来，在阅读时比较简洁和易于理解 例： #region 代码段说明 #endregion
触发器分为行级 Row【R】和语句级 Statement[【S】， 又分为 after【A】，before【B】，instead of【I】，
方法又有三种 Insert【I】,Update【U】,Detele【D】， 所以：如:trg_User_Info_RBI（代表语句级,之前,插入操作）,有点专业,不知道
写法 3：seq_User_Info_UI_ID（表名加字段名）
trans_ crs_
@面向用户或者应用名，这个以用户名或者应用名加后缀组成 数据表空间以用户名+_+data 命名 索引表空间以用户名+_+idx 命名
专用临时表空间以用户名+_+tmp 命名 专用回滚段表空间以用户名+_+rbs 命名
1.5 方法
1) 使用动词或动词短语命名方法。 2) 采用 Pascal case，所有单词第一个字母大写。 3) 方法中的参数命名采用 Camel casing,所有单词第一个字母大写，除了首字母小写。
1.6 属性
1) 使用名词或名词短语命名 2) 采用 Pascal case，所有单词第一个字母大写 3) 少用缩写 4) 不要使用下划线字符( _ )
特殊处理： @LOB 段数据专用表空间后面再加_lobs 命名
总则：不管你用什么命名方法，所有的命名规则一定要统一，不要一会儿中文拼音一会 儿英文等等。 1、采用英文单词或英文短语（包括缩写）作为名称，不能使用无意义的字符或汉语拼
音。
2、每个数据库对象表，视图，字段，存储过程，不要用任何数据库的关键词作为名称。
凡是能写注释的地方，应该写上注释பைடு நூலகம்以便查看。
3、名称应该清晰明了，能够准确表达事物的含义，最好可读，遵循“见名知意”的原则。
1.11 注释
注释规范包括：类注释规范、类的属性、方法注释规范、代码间注释规范
1.11.1 类注释规范
类开始必须以以下形式书写类注释： ///<summary> ///类的描述: ///作者： ///创建时间：<格式：YYYY-MM-DD> ///</summary>
1.11.2 类属性注释规范
在类的属性必须以以下格式编写属性注释： /// <summary> /// 属性说明: /// </summary>
fk_
fk_从表名字段_主表名字段。这个推荐
idx_
idx_表名_字段名(一个或多个)【可以在其后加 U 或者 C,规则同触犯器】 推荐使用：idx_字段名
一是唯一 Unique【U】与非唯一 NonUnique【N】 一是聚集 Cluster【C】与非聚集 NonCluster【N】
ck_
1. 默认约束：df_表名_列名，df_列名
bln byt char dbl flt int lng obj str
前缀 coll dt ds drd dr dc hs xml xr
2) 类的私有变量，在遵循第一条规则后，在其前加“m_”前缀。 例: public class Hello {
private string m_strName; public string Name {
函数 主键
外键 索引
约束
命名规则的人看不明白。
fn_ fn_功能名称。一些是具体的操作函数，比如字符串处理,fn_SplitStr(参数)处理字符
f_
串，如果与模块相关，则 fn_模块名称_具体方法
pk_
pk_表名[或缩写]_列名
简洁的写法：
写法一：pk_表名，
写法二：pk_列名，因为列名设计时已经包含表的含义
3 SourceSafe 使用规范
代码维护一律使用 内嵌的集成方式，不要使用 VSS 客户端工具（客户端工具仅用来 维护文档版本）。
注意： 必须安装 2003 安装程序内带的 VSS 版本（6.0d），才能与 环境集成。 如果已安装其它早期版本，请先卸载再安装新版本。
1.7 变量
1) 变量名称 = 变量的前缀 + 代表变量含意的英文单词或单词缩写。
常用变量类型的前缀命名规则，定义如下：
类型
前缀
bool byte char double float integer long object string 常用对象: 类型 Collection DateTime DataSet DataReader DataRow DataColumn Hashtable XmlDom XmlReader
4、对长度也要有限制，最好不要超过 30 个字符，在 PD 设置生成时，部分数据库对
象会自动截取到 30 位。
5、所有名称的字符范围为：A-Z, a-z, 0-9 和_(下划线)。不允许使用其他字符作为
名称。
6、注释分单行和双行，在数据库对象如函数，存储过程，视图等，都需要在页头添加
数据 库对 象
表
1.11.3 方法注释规范
在类的方法声明前必须以以下格式编写注释 /// <summary> /// 说明：<对该方法的说明> /// </summary> /// <param name="<参数名称>"><参数说明></param> /// <returns> ///<对方法返回值的说明> /// </returns>
3.1 创建项目
第一个创建项目的人应在 2003 环境下的菜单中选择“文件”—〉“源代码管理 器”—〉“将选定项目添加到源代码管理器”（注意：不要选择“将解决方案添加到源代码管 理器”）。
下图是一个 Project 的资源管理视图，其中 bin、obj 两个灰色的目录是 2003 自动生 成的临时文件夹，用来保存编译过程中的临时文件，不应上传到 SourceSafe 上，否则会因为指 读属性影响本地编译结果。
前缀
命名说明
写法一：模块名_具体功能实体名，如用户角色表 User_Role 等， 写法二：直接写成 UserRole，不用"_"来区分，看习惯和所用数据库。
表名缩 列名 写_
写法：表名缩写_具体内容 如用户角色表 User_Role 的名称：UR_Name， 如果是单个的表名，比如区域表 Area,则可以写成 Area_ID。
1.11.4 代码间注释规范
代码间注释分为单行注释和多行注释： 单行注释：
//<单行注释> 多行注释：
/* 多行注释 1 多行注释 2 多行注释 3
*/
2 C#代码格式规范
1) 所有的缩进为 4 个空格，使用 的默认设置。 2) 在代码中垂直对齐左括号和右括号。(需讨论) 例： if(x == 0) {
命名
Btn Chk Cmb Dtb Grb Lbl Lkp Num Pnl Pgb Rad Txt Memo Tvw
DataGrid DataList Image DropDownList
Grid List Img Drp
1.10 数据集命名规范
1) 普通数据集命名以 Ds 开头 2) 作为查询参数的数据集命名以 DsQuery 开头，表名以 QUERY_为前缀 3) 元素的所有字母大写，各字母以下划线“_”分割 4) 专用名词建议使用习惯缩写 5) 与后台交互的数据集不允许使用属性
Response.Write("用户编号必须输入！"); } 不允许以下情况： if(x==0) {
Response.Write("用户编号必须输入！"); } 或者： if(x==0){ Response.Write("用户编号必须输入！");} 3) 为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在 1024*800 的显示
1.8 常量
1) 常量的名字应该都大写，并且指出完整含义，单词之间用下划线（_）分隔。 例： const int PAGE_COUNT = 10;
1.9 控件
前台系统开发时，只能使用下面列出的控件，又不能满足要求请先和模块负责人联系。讨 论通过后才可使用，规范修改前严禁使用未列出的控件。Framework 有提供相应控件的，不得 使用.Net 标准控件
控件命名 = Window 控件缩写前缀 + 变量名
控件类型
Button CheckBox ComboBox DateTimeBox GroupBox Label LookupBox NumericBox Panel ProgressBar RadioButton TextBox MemoEdit TreeView
get {
return m_strName; } }
