admin 管理员组文章数量: 887031
2024年1月23日发(作者:javalibrary新加入)
程序设计与编程规范
一、 基本要求
1.1 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。
1.2 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
1.3 尽量使用标准库函数和公共函数。
1.4 不要随意定义全局变量,尽量使用局部变量。
1.5 定义变量的用途要明确。
1.6 定义的变量的数据类型和可见范围清晰明了,必须遵循先定义后使用,且必须写在过程或函数定义头的第一行,可以放在异常处理行之后。
1.7 定义的函数与过程易于理解,命名要规范。
1.8 使用括号以避免二义性。
1.9 不要将多个语句放在同一行上。
2.0 对于长代码行要使用行接续符(&),换行使用(_)。
2.1 代码中出现的SQL语句要求SQL关键字全部大写,表名和字段名小写。例如:”SELECT name FROM user_info WHERE accept=1”。
2.2 在以下情况下要插入空白行:
每个IF…Then构造的前面和后面(尤其是IF语句前的注释的前面)。
每个Select Case构造的前面。
每个循环的前面和后面。
变量定义块的说明的后面。
执行统一任务的两个语句组的中间。
过程和函数之间。
二、 可读性要求
2.1 可读性第一,效率第二。
2.2 保持注释与代码完全一致。
2.3 每个源程序文件,都有文件头说明,说明规格见规范。
2.4 每个函数,都有函数头说明,说明规格见规范。
2.5 主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。
2.7 常量定义(DEFINE)有相应说明。
2.8 处理过程的每个阶段都有相关注释说明。
2.9 在典型算法前都有注释。
2.10 利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为4个字节。
2.11 循环、分支层次不要超过五层。
2.12 注释可以与语句在同一行,也可以在上行。
2.13 空行和空白字符也是一种特殊注释。
2.14 一目了然的语句不加注释。
2.15 注释的作用范围可以为:定义、引用、条件分支以及一段代码。
2.16 注释行数(不包括程序头和函数头说明部份)应占总行数的 1/5 到
1/3 。
三、 结构化要求
3.1 禁止出现两条等价的支路。
3.2 尽量少用或不用GOTO语句,异常处理除外。
3.3 用IF语句来强调只执行两组语句中的一组,禁止 ELSE GOTO 和 ELSE
RETURN。
3.4 尽量用 CASE 实现多路分支。
3.5 避免从循环体内部引出多个出口。
3.6 函数只有一个出口。
3.7 不使用条件赋值语句。
3.8 避免不必要的分支。
3.9 不要轻易用条件分支去替换逻辑表达式。
四、 正确性与容错性要求
4.1 程序首先是正确,其次是优美
4.2 无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。
4.3 改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。
4.4 所有变量在调用前必须被初始化。
4.5 对所有的用户输入,必须进行合法性检查。
4.6 不要比较浮点数的相等,如:10.0 * 0.1 == 1.0 ,不可靠
4.7 程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否逻辑锁定、打印机是否联机等。
4.8 单元测试也是编程的一部份,提交联调测试的程序必须通过单元测试。
五、 可重用性要求
5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
5.2 公共控件或类应考虑OO思想,减少外界联系,考虑独立性或封装性。
5.3 公共控件或类应建立使用模板。
六、 文件注释规范(写在每个.frm或者.bas文件头)
6.1 以’-----------------------------------------------------开始与结尾
6.2 File Name:文件名
6.3 Author:作者 Version:版本 Date:及完成日期
6.4 Description:用于详细说明此程序文件完成的主要功能,与其他模块或函数的接口,输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。
6.5 Function List :主要函数列表,每条记录应包括函数名及功能简要说明
6.3 History:修改历史记录列表,每条修改记录应包括修改日期、修改人及修改内容简述。
Date:
Autor:
Modification:
七、 函数过程注释规范
7.1 以’-----------------------------------------------------开始和结尾
7.2 Description:功能描述
7.3 Parameters:参数说明
7.4 Table Accessed:被访问的表(此项仅对于牵扯到数据库操作的程序)
7.5 Table Updated:被修改的表(此项仅对于牵扯到数据库操作的程序)
八、 异常处理规范
8.1
8.2
使用On Error Resume Next以忽略错误。
使用On Error GoTo转移执行的代码行。
九、 界面设计规范
9.1
9.2
9.3
程序中所有应用程序界面必须保持一致。
使用户能充分利用他们现有的技巧,减少用户在操作中的混乱和困难。
使用醒目的界面,建立用户的自信,使用户感到满意。
9.4 用简明扼要的专业性语言告诉他们必须知道的信息。
版权声明:本文标题:VB程序开发设计规范 内容由网友自发贡献,该文观点仅代表作者本人, 转载请联系作者并注明出处:http://www.freenas.com.cn/free/1705985065h496725.html, 本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,一经查实,本站将立刻删除。
发表评论