阅读材料VB编程规约与规范.pdfVIP

№4 VB 编程规约与规范 4.1 注释规范2 1. 函数(Function)、子程序模块(Subprocedure module)的注释2 2．窗体模块、标准模块、类模块的注释3 3．代码修改部分的注释4 4．变量的注释4 5．IF、FOR、CASE等语句处理块的注释4 4.2 命名规约 5 1．Project文件名（.VBP）5 2．可执行文件名（.EXE, .DLL）5 3．Module文件名（.FRM, .BAS, .CLS）5 4．函数名（Function，Sub) 6 5．Object名7 6．控件名8 7．变量名8 8．常量名9 9．用户定义类型9 4.3 程序代码书写格式规范9 1. 一行中禁止记述多条语句9 2. 一条变量定义语句中，只能出现一个变量10 3．SQL语句不要在一行内完整记述，每项应占一行10 4．缩进(锯齿状)代码书写格式 11 4.4 人机接口规约 11 1．光标控制 11 2．窗体显示12 1 №4 VB 编程规约与规范 №4 VB 编程规约与规范 在团队开发作业时，必须在统一的规则下编写各类文档，尤其需要强调的是不允许带有 个性化的、随心所欲的编程。只有这样，才能保证系统的可读性、可移植性和可修改性。对 一些习惯于趣味编程的人来说，很不习惯受到编程规约的束缚，感到非常麻烦，并且认为不 一定非要百分之百地按照规约去做，只要程序能按照设计要求正常运行就行，即使有一些不 规范也无妨。这种习惯和想法必须去除。应该认识到，按照规约和规范编程，不仅仅是为了 团队，也是为了自己。因为在项目开发过程中，设计变更的情况时有发生，自己编写的程序 还需自己修改，不规范的源程序同样会给编程者自身带来麻烦。 在系统的设计阶段，设计人员首先详细地规定了系统的开发规范及编程规约。根据系统 的开发环境及开发语言的不同，规约与规范在一些具体的细节上有所不同，编程人员在编写 程序时必须认真阅读具体的条文并且严格遵守。 本章中归类了一些常用的也是最基本的 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 修改者名 通过传递参数，可使文件成员得到