软件项目开发综合实训——Visual Basic篇 教学课件 作者 王泰峰 演示文稿(编程规约与规范).pptVIP

第4章 编程规约与规范 * * 　　　本章中归类了一些常用的也是最基本的VB编程规约和规范条款，要求学员在实训过程中严格遵守，从而养成编程的良好习惯。 4.1 注释规范 1. 函数(Function)、子程序模块(Subprocedure module)的注释 Function BtrvClose (iFileNum As Integer) As Integer ******************************************************************************* *　函 数 名: Function BtrvClose () As Integer *　功能概要: 关闭 Btrieve 文件 *　参 数: ByVal iFileNum As Integer(IN) 对应于文件的成员 *　返 回 值: status code *　 CLASS : ZZZD001.clsZZZD001 * 更新履历: 2004/12/08 Ver001 by 编程者名 ‘* 　　　　 : 2005/01/13 Ver002 by 修改者名 通过传递参数，可使  文件成员得到释放 ‘*　备 考: 此函数通常是在 Form Unload 时调用 ******************************************************************************* 2．窗体模块、标准模块、类模块的注释 Option Explicit ***************************************************************************** *　功能名称: 通用功能的日历登录 ‘*　版 本: 1.01 ‘*　功能概要: 以年度(1月1日～12月31日)为单位，对日期进行增、 删、改、检索 * 更新履历: 2004/12/01 by 编程者名 ‘* 　　　　 : 2005/03/13 by 修改者名 追加了检索功能 ‘*　备 考: 无 ***************************************************************************** 3．代码修改部分的注释 注释格式： [识别符] + By + [修改者] + [日期] + [(特定内容)] 4．变量的注释 5．IF、FOR、CASE等语句处理块的注释 4.2 命名规约 下面列举了几种基本的命名规约，这些规约应在编程时注意查对和遵守： 1．Project文件名（.VBP） 2．可执行文件名（.EXE, .DLL） 3．Module文件名（.FRM, .BAS, .CLS） 4．函数名（Function，Sub) 5．Object名 6．控件名 7．变量名 8．常量名 9．用户定义类型 4.3 程序代码书写格式规范 在编写程序时，需注意以下最基本的书写规范： 1. 一行中禁止记述多条语句 2. 一条变量定义语句中，只能出现一个变量 3．SQL语句不要在一行内完整记述，每项应占一行 4．缩进(锯齿状)代码书写格式 4.4 人机接口规约 随应用系统的不同，对人机接口规约也有所区别，本实训系统的规约如下： （这些规约直接面对用户视觉和操作） 1．光标控制：① 鼠标光标的状态 ② 光标焦点（focus）的移动 2．窗体显示：① 窗体属性的定义 ② 画面上数据的显示形式 ③ 信息显示时调用的函数及其变量