|
对象类型 |
命名方法 |
举例 |
说明 |
|
表 |
模块代号_+表名+[_表类型] |
Pur_po_master、pur_po_detail、pur_vendor_info |
通常后缀为master的表存储事务主数据，后缀为detail的表存储事务明细数据，后缀为info的表存储基础数据（也可不带后缀），后缀为rpt的表存储报表数据。表名一定要体现所属模块。 |
|
视图 |
V_+模块代号_+视图名 |
V_inv_transaction_detail、v_sys_newmessage |
如果是直接建立在基表上的视图，可以直接使用“v_表名”命名 |
|
存储过程 |
Usp_+模块代号_+存储过程名称 |
Usp_sys_createmailtrigger、
Usp_sys_dropmailtrigger |
为了区分是用户创建的存储过程还是系统自带的存储过程，建议不要以“sp”为前缀命名存储过程 |
|
函数 |
Udf_+模块代号_+函数名称 |
Udf_sys_getchildmenuid、
udf_sys_gettriggerlistbystatus |
为了区分是用户创建的函数还是系统自带的函数，建议不要以“fn”为前缀命名函数 |
|
触发器 |
T+触发器类型+表名+[_序号] |
Ti_pur_po_master、td_pur_po_master、
Tii_pur_po_master |
如果是后触发器，可以使用i表示插入、u表示更新、d表示删除，如果是前触发器，可以再增加i标识，对于一些特殊功能的触发器（如自动跳号、自动邮件），可以添加到触发器类型中，如果同一类型触发器有多个，可以加上序号作为后缀 |
在命名SQL变量时建议体现数据类型（如以c表示char），如果是存储过程或函数的参数，建议以“a+数据类型+变量名称”表示。在后台开发中经常要获取栏位值，建议在命名变量时直接使用栏位名称，如@vc_user_name或@user_name。
设计文档包含很多种，如概要设计、详细设计、单元测试等文档，推荐使用国家软件开发标准GB8567并适当剪裁。
尽管程序中可能有不少注释，但可虑到源代码的安全性，并非每个开发人员都能获取非本人负责的源代码，还是有非常有必要开发相关的帮助文档。Microsoft、Sybase等开发工具所带的帮助文档可以作为我们制作技术性帮助文档的范例。
以上所列的规范并非软件开发时的全部规范，笔者也只是简单地讲述了一番，并未深入。读者可以参考其他的软件开发相关教程。在制定规范时应着眼于使开发人员操作简单、便于阅读、普遍接受为原则，切忌大而全不适用。
由于开发人员也是普通人，在开发过程中也可能存在偶尔的不遵守规范行为，可以通过日常的代码检查、评审找出并纠正。作为一个负责任的框架开发人员，应认识到自己所编写的程序、文档往往被事务层开发人员所继承或参照，如果你很好地遵守规范，就会带动更多的开发人员遵守规范，这样才有利于标准的有利推行和良好的沟通，如果你不能较好地遵守规范，可能造成更多的开发人员随意发挥、破坏规范，你也将花费更多的不必要时间为事务层开发人员讲解你的代码用途。
本文作者:康剑民 来源:http://blog.csdn.net/pbdesigner/archive/2009/03/02
CIO之家 www.ciozj.com 微信公众号:imciow