读书人

开发定名规范

发布时间: 2012-10-07 17:28:51 作者: rapoo

开发命名规范

?

?

表tbUser_Info、tbMessage_Detail视图vi_MessageList存储过程sp_MessageAdd


数据库表命名规则


  字段由前缀和实际名字组成。实际名字中首单词一个系统尽量采取同一单词。
  前缀:使用小写字母tb,表示表。
  例如:tbMember
     tbMember_Info
     tbForum_Board
     tbForum_Thread1


字段命名规则

  数字、字符、日期/时间、lob(大对象)、杂项,字段由表的简称、下划线,实际名字加后缀组成。
  后缀:使用小写字母,代表该字段的属性。
   例如:  User_Idint
       User_Namestr
       User_RegDatedtm


视图命名规则


    字段由前缀和实际名字组成,中间用下划线连接。
    前缀:使用小写字母vi,表示视图。
    例如:vi_User
       vi_UserInfo

存储过程命名规则


    字段由前缀和实际名字组成,中间用下划线连接。
    前缀:使用小写字母sp,表示存储过程。
    例如:sp_User

数据库设计文档规则


  所有数据库设计要写成文档,文档以模块化形式表达。大致格式如下:
  '-------------------------------------------
  '  表名:  tbUser_Info  
  '  建立人:UAM_Richard
  '  日期:  2004-12-17
  '  版本:  1.0
  '  描述:  保存用户资料
  '  具体内容:
  '  UserId  int,自动增量  用户代码
  '  UserName  char(12)  用户名字
  '  ......
  '--------------------------------------------

sql语句规则


  所有sql关键词全部大写,比如SELECT,UPDATE,FROM,ORDER,BY等。

?

?

后记:

  良好的命名对于软件开发起着至关重要的作用,能够对资源进行合理的命名,可以达到事半功倍的效果。无论是哪种命名规则,无论是对哪种资源进行命名,其核心思想都是“用最少的字母进行最全面的描述”。正如本文开始时强调的,“唯一性+描述性”是命名的灵魂。所以,在您对程序的各个方面进行命名的时候,不妨去参照着这两大原则去进行,切记不可图一时之快,却为日后的修改或维护带来巨大的困难。

1 楼 ucetgg 2010-06-29 a a a

读书人网 >软件架构设计

热点推荐