/*----------------------------------------------------------------
*author: wood
*create time:9/3/2007 9:35 AM
*modify time:
*------------------------------------------------------------------*/
变量(对象)命名
一.数据库:
1.基本命名规则
表1. 基本数据库对象命名
数据库对象 |
前缀 |
表(Table) 字段(Column) 视图(View) 存储过程(Stored procedure) 触发器(Trigger) 索引(Index) 主键(Primary key) 外键(Foreign key) Check约束(Check Constraint) Default约束(Default Constraint) 用户定义数据类型(User-defined data type) 用户定义函数(User-defined function) |
tbl_ 无 viw_ prd_ trg_ idx_ pk_ fk_ ck_ df_ udt_ fun_ |
2.关于命名的约定
变量(T-SQL编程中声明的变量)、过程(存储过程或触发器等)、实体(表、字段)应该根据他们所代表的实体意义和进程作用来命名:
表2.好的命名 和 不好的命名 范例
好的命名 |
不好的命名 |
@CurrentDate @ActivityCount @EquipmentType prCalculateTotalPrice |
@D @ActNum @ET @prRunCalc |
a.动宾形式:动词放前面,名词放后面。eg:prd_GetProductById
b.不要使用计算机术语,尽量使用面向公司业务的术。
c.采用缩写
如果完全根据上一条的要求,那么根据业务描述的过程名可能会变得很冗长,比如下面:
prCountTotalAmountOfMonthlyPayments (计算每月付费的总金额)
prGetParentOrganizationalUnitName (获取上级单位名称)
Ø 如果可以在字典里找到一个词的缩写,就用这个做为缩写,比如:Mon(Monday)、Dec(December)
Ø 可以删除单词元音(词首字母除外)和每个单词的重复字母来缩写一个单词。比如:Current = Crnt、Address = Adr、Error = Err、Average = Avg
Ø 不要使用有歧异的缩写(一般是语音上的歧义)。比如b4(before)、xqt(execute),4tran(Fortran)
3.数据库命名
根据项目的实际意义来命名
4.表命名
“tbl_”+ 名称(名称尽量使用英文单词,每个单词的首字母大写)
5.字段命名
表名(去掉前缀)缩写 + ”_”+ 属性名称(每个单词的首字母大写)
缩写:五笔拆字法取字母
一个单词:取前四个字母
二个单词:取每个单词的前两个字母
三个单词:取前两个单词的首字母和第三个单词的前两个字母。
四或四个以上:取前三个单词的首字母和最后一个单词的首字母。
6.主键命名
主键是针对一个表的, 而不是针对一个字段,因为主键是唯一的,一个表只能有一个主键。
a.一般主键命名:主键的命名为 pk_TableName。
b.复合主键:”pk_” + “字段名”
e.g.: Constraint pk_StudentCourse Primary key(Stud_Id, Cour_Id)
主键pk_StudentCourse,包含了两个字段Stud_Id和 Cour_Id
7. 外键命名
外键的命名为 fk_外键所在的表名_外键引用的表名。因为外键所在的表为从表,所以上式可以写为 fk_从表名_主表名。
8.Check约束命名
“ck_” + “表名”“_” + “字段名”
e.g.:ck_tbl_Company_Comp_Zip
9.Default约束命名
“df_” + “表名”“_” + “字段名”
e.g.:df_tbl_News_News_Hit
10. 触发器命名
“trg_” + “表名” + “后缀”
a. 前缀-“trg_”,描述了数据库对象的类型。
b. 基本部分,描述触发器所加的表。
c. 后缀(_I、_U、_D),显示了修改语句(Insert, Update及Delete)
11. 存储过程命名
命名的规则:见名知意.
“prd_” + “说明”
说明:动宾结构(动词+名词)
e.g.:prd_GetProductById
12. 存储过程中参数的命名
与其对应的字段名相同,第一个单词小写.
二.程序设计
以微软3.0文档为主
1.项目名称
“公司名称” + “项目实际意义名称”
e.g.:qikingYellowPage
2.页面命名
规则:每个单词的首字母大写,因为它是类。
a. 父页面——使用名词进行描述
b. 子页面_列表——“List” + “父页面”
c. 子页面_详细—— “Show”+ “父页面”
3页面传值
“Id_” + “页面名称”
4.错误页面命名
Error.aspx
5.用户登录
UserLogin.aspx
6.文件夹命名
单词首字母大写
单数或复数,根据实际需要而定.
注:其中一部分参考了 张子阳的《数据库对象命名参考》Second Edition http://www.cnblogs.com/JimmyZhang/archive/2007/08/30/875504.html
根据个人的习惯增加、修改了一些。