delphi数据库系统应用程序开发规范
灵智集团 项目名称： 名佳商务管理系统 20101122 编制：胡建平 第 1 页/共 7 页 灵智集团 广州灵智世纪科技有限公司 地址：广州市天河北路 906 号高科大厦 A座 2905 层 电话：02038258890,9010,9011 传真：38259109,9107 本源码下载地址：http:/vip.hur.cn/ Delphi Delphi 数据库系统应用程序开发规范 数据库系统应用程序开发规范 摘要：摘要：众所周知，Delphi6.0Delphi6.0 是一种功能十分强大而灵活的可视化开发环境。但是，正因为它的灵 活性，使得程序员的开发容易陷于一种散漫的、不规范的开发过程中。这种散漫的、不规范的开发过程 将使得代码的可读性、可维护性极差。当需要对这样的代码进行维护升级进，将感到无从下手。而且， 从软件质量的角度来说，软件的可维护性差也可以说是软件质量差的一个重要方面。 正是为了对程序员的开发进行适当的规范化，特制定本规范。其根本目的，也无非是从程序员这一 层对 DelphiDelphi 程序开发作一约束，保证程序具有良好的一致的结构，以期提高程序的可读性及可维护性， 方便程序的测试、维护升级等工作。 1开发流程1开发流程 这里所说的“开发流程” ，是指项目在需求分析和概要设计完成之后，到进行集成测试之前的阶段， 即包括界面设计、详细设计、编程、单元测试几个阶段。针对这几个阶段，一方面为了较为规范且有效 的工作，另一方面也为了在此基础上更精确地估算工作量及进行进度控制，建议遵循如下的开发流程： 2命名规则2命名规则 2 1 DelphiDelphi 中的所有保留字都应该使用小写， 且不能挪为他用， 如 const、const、 varvar、 procedureprocedure、 type、 type、 functionfunction 等； 22方法（过程、函数）命名 采用描述性英文、动宾结构。每个单词的首字母采用大写，如 LoadProjectLoadProject、ClearProjectClearProject、 、 CreateNewProjectCreateNewProject 等； 23变量命名 方式：类别前缀 + 描述性英文 231类别前缀 业务逻辑 理解分析 界面及迁 移设计 详细设计 /DB 设计 构建 拟定编程 计划/进行 任务切分 编程/ 单 元测试 项目管理者及 界面设计师 项目管理者 程序员 项目所有成员 文档、代码 及目标程序 需求分析/概 要设计文档灵智集团 项目名称： 名佳商务管理系统 20101122 编制：胡建平 第 2 页/共 7 页 灵智集团 广州灵智世纪科技有限公司 地址：广州市天河北路 906 号高科大厦 A座 2905 层 电话：02038258890,9010,9011 传真：38259109,9107 全部用小写英文字母，采用以下列表（这里只列出部分类，需要时可适当补充） ： Standard 页 页 前缀 前缀 构件 构件 mm TMainMenu pm TPopupMenu 前缀 前缀 构件 构件 mmi TMainMenuItem pmi TPopupMenuItem lbl TLabel edt TEdit mem TMemo btn TButton cb TCheckBox rb TRadioBox lb TListBox cb TComboBox scb TScrollBar gb TGroupBox rg TRadioGroup pnl TPanel cl TCommandList Additional 页 页 bbtn TBitBtn sb TSpeedButton me TMaskEdit sg TStringGrid dg TDrawGrid img TImage shp TShape bvl TBevel sbx TScrollBox clb TCheckListbox spl TSplitter stx TStaticText cht TChart Win32 页 页 tbc TTabControl pgc TPageControl il TImageList re TRichEdit thr TTrackBar prb TProgressBar ud TUpDown hk THotKey ani TAnimate dtp TDateTimePicker tv TTreeView lv TListView hdr THeaderControl stb TStatusBar tlb TToolBar clb TCoolBar Data Access 页 页 ds TDataSource tbl TTable qry TQuery sp TStoredProc db TDataBase ssn TSession bm TBatchMove usql TUpdateSQL Data Controls 页 页 dbg TDBGrid dbn TDBNavigator dbt TDBText dbe TDBEdit dbm TDBMemo dbi TDBImage dblb TDBListBox dbcb TDBComboBox dbch TDBCheckBox dbrg TDBRadioGroup dbll TDBLookupListBox dblc TDBLookupComboBox dbre TDBRichEdit dbcg TDBCtrlGrid dbch TDBChart灵智集团 项目名称： 名佳商务管理系统 20101122 编制：胡建平 第 3 页/共 7 页 灵智集团 广州灵智世纪科技有限公司 地址：广州市天河北路 906 号高科大厦 A座 2905 层 电话：02038258890,9010,9011 传真：38259109,9107 232描述性文字 由描述性单词组成，这些单词以大写字母开头且后接小写英文字母； 24单元文件名 241一般命名 单元文件名请用描述性英文单词命名，其中第一个单词的开头字母小写； 242FormForm 命名 对于窗口名称用后缀名 FormForm 命名,其所对应的单元文件，就用该 FormForm 名称去掉“FormForm”之后的英文 描述，如：主 FormForm 的对象名称为：MainFormMainForm，则其对应的 unitunit 文件名为：mainmain； 25常量命名 常量由描述性单词组成，这些单词全部采用大写英文字母； 26其他说明 对于只起界面作用并且在代码中未引用的控件，可以不为其命名，如：一个按钮，由于为其设置了 actionaction,并且在代码中从不使用该按钮的名称，则可以不为其命名，采用 DelphiDelphi 自动命名即可（如 Button1Button1 之类） ； 3注释规则3注释规则 “源代码不仅仅是写给程序员自己看的，源代码不仅仅是写给程序员自己看的，更重要的是写给其他程序员看的。更重要的是写给其他程序员看的。 ”换句话说，源代码更 重要的作用是交流交流。因此，为了提高软件的可读性、可维护性，程序员在编写源代码时，加上一定的注 释是相当必要的，应该把注释当成软件的一个不可缺少的一部分。 如：单元文件: * 项目名称 版权所有 (C) 2000,2001 公司名称 * unit UnitName; * 项目: 模块: 描述: 版本: 日期: 作者: 更新: TODO: * 4界面设计规则4界面设计规则 软件的界面设计已经形成默认的工业标准， 界面设计的主要原则是简洁、 明快， 使用户容易上手 （如 何设计更加优秀的人机界面，一个很好的方式就是学习、模仿优秀的软件界面） ： 41用户观察窗体的习惯一般是从左上角到右下角，因此软件设计者应该将窗体中最重要的组件灵智集团 项目名称： 名佳商务管理系统 20101122 编制：胡建平 第 4 页/共 7 页 灵智集团 广州灵智世纪科技有限公司 地址：广州市天河北路 906 号高科大厦 A座 2905 层 电话：02038258890,9010,9011 传真：38259109,9107 尽量放在左上角； 42一个窗体上的组件切忌太多，色彩搭配要合理； 43由于因特网的发展，用户已经习惯于使用 IEIE 或 NetScape NavigatorNetScape Navigator 浏览器软件，因此，软 件界面可采用与上述浏览器类似的界面与操作方式； 44软件一定要提供必要且充足必要且充足的键盘支持；用 Enter 代替 Tab 键切换控件焦点(从左到右,由上 而下键盘操顺序) 45软件中的联机求助一定要丰富； 46用“”标记菜单项或按钮的执行将会弹出一个对话框窗体； 47状态条提示信息必须充分，快捷键的提示位置要明显，便于用户发现。 5程序结构规则5程序结构规则 51一般结构 在进行 DelphiDelphi 的数据库程序开发时， 请务必遵守以下的程序结构规范， 以增强代码的结构性和可读 性能、可维护性； 总的来说，DelphiDelphi 程序由多个 unitunit 组成，这些 unitunit 从结构上可以分为以下两层（与用户界面无关 的全局层和与用户界面有关的 GUIGUI 层） ： 511与用户界面无关的全局层 此层主要是指可随时在其他 unitunit 中引用的 unitunit， 包括： Data Module unit、 Data Module unit、 utils unit、 utils unit、 global unitglobal unit 等与整个应用程序有关的功能和数据； 512与用户界面有关的 GUIGUI 层 此层则是指与用户界面有关的功能， 由主窗口 unitunit 及适量的子窗口 unitunit 及对话框 unitunit 组
