编码规范SQL.doc

浙江榕基信息技术有限公司 编码规范SQL分则 【修订记录】 批准日期 修订说明 编制部门 2012/04/12 初稿 研发中心 目 录 1 对象命名规则 2 1.1 表命名 2 1.2 字段、变量命名 2 1.3 存储过程命名 2 1.4 触发器命名 2 1.5 用户定义的数据类型 3 1.6 用户定义的缺省 3 1.7 用户定义的规则 3 1.8 索引名 3 2 源程序规范 3 2.1 源文件头部描述 3 2.2 过程、函数命名 3 2.3 过程、函数头部描述 3 2.4 语句、过程、函数体书写规范 4 3 SQL表更改顺序 4 对象命名规则 应使对象命名应保持一致的风格，全部采用小写，中间以下划线（_）连接，其前缀按照以下规则： 表命名 小写前缀： 和业务相关的表应该以业务简拼开头如“das_user_info” t 表示数据表，放置收集来的原始数据； v 表示视图； 注解说明：表的中文名称，数据内容总体意义，数据来源，一致性维护要求，关键字，索引。 字段、变量命名 小写前缀： sz 字符串 c 字符 I 整数 f (或nmr) 浮点数（双倍浮点数） d 日期 b 布尔 t TEXT文本 im Image 不同表中的同名字段，在应保持相同的含义； 存储过程命名 小写前缀：rj[l1]sp 注解说明：存储过程中文名称，即功能定义；过程流程图；采用特殊的技术或技巧名称；所传递的参数必须都有说明。 触发器命名 小写前缀：rj[l2]tg 用户定义的数据类型 小写前缀：无； 用户定义的缺省 小写前缀：无； 用户定义的规则 小写前缀：无； 索引名 主索引：idx + 表名 其他索引：idx + 表名 + 简要说明索引意义的串（索引名长度30字符） 源程序规范 源文件头部描述 参见《总则》说明； 过程、函数命名 函数名应清晰反映函数的功能、用途, 推荐使用动宾结构,不宜过长，一般不超过30字符。 过程、函数头部描述 对过程、函数都要有头部描述； 先写好头部描述，再编写过程或函数，即先设计再编程； 头部描述内容如下： 功能(中文) 输入参数 输出结果(对函数) 引用的外部变量说明 关键的过程和函数，画出它的流程；（伪代码） 开发者自己的测试结果；如果有测试开发的文挡和程序，要保留并表明保留的位置标志 注：红色可选 例： 名称: 功能: 参数说明: 返回: 调用格式: 对环境引用: 对环境影响: 内部变量说明: 调用函数列表: 被调函数列表: 中文名称 (可选的) 简述函数或过程的功能 列出主要的、不易理解的参数含义和取值范围 返回值含义 (可选的) (可选的) (可选的) (可选的) (可选的) (可选的) 语句、过程、函数体书写规范 变量申明必须放在头部； 内容超过一行时select、update、insert、where、and子句一定要分行写，特别是and条件限制子句；将关键字提到前面醒目的位置; TAB(4字符)缩进； 注：如果是已有版本的升级，可保持原有的风格。 注释对于多条采用/* */，对于单条采用 -- 用合理使用空格分隔语句中的各种元素，使源程序舒展，可读，如：赋值符前后加空格。 尾部保留一行空行，以防止生成加密文件时最后的执行指令与下一文件第一行连接在一起，导致执行失败。 使用TAB键进行空格时，在文档编写完成提交时，应使用相应的工具将TAB全部转化为空格，以利于其他人的阅读。 SQL表更改顺序 为防止数据库发生死锁，采用数据库的每个产品的《数据库设计说明书》中，都应该有‘SQL表更改顺序’章节，对于一个事务中的所有涉及表有一个更改顺序的约定。项目编码人员在编写/修改数据库代码时，必须遵守这些约定。 例，企业版1.0的SQL表更改顺序如下： 流水号表 — 参数表 — 客户表 — 资金表 — 证券表 — 委托表 — 非流水其他表 — 流水表 由于sp是SQL SERVER系统本身存储过程所用到的开头字母，其处理时有特殊性，因此对于我们自定义的存储过程，最好不用sp，考虑在前面再加rj 现样也考虑不使用标准的定义，以防止系统缺省处理