1、变量定义
部件名称不超过40个字符,组成方式为A_B_C...。
A部分表示前缀,B部分表示后缀。
紧跟着一条下划线“_”。
A和B和…要有实际意义,具有一定的规律。
项目的变量定义最好是用统一的命名方式,如果变量用每个汉语拼音开头字母缩写都用每个汉语拼音开头字母缩写(如:水池液位:SCYW或者SC_YW),用英语都用英语,尽量简单化。个别不容易识别变量的要在归档中加以注释说明;
某些时候也可以用汉字来定义变量。
变量的定义应该用Excel文件保存一份完整的注释,同项目文件一起备份。
2、函数定义
(1) 函数的命名规则
函数名=‘函数适用范围代码’ +‘f’+‘_’+‘函数功能描述’,其中函数的适用范围代码和意义如下:
g 全局函数;
w 窗口函数;
m 菜单函数;
u 用户对象函数。
例:检查SQL语句执行结果的全局用户函数命名如下:gf_checksql()。
(2)初始化配置文件
初始化配置文件的命名必须与应用的名称一致,扩展名为.ini,例如:si.ini。用户的可变环境信息都应该保存在该文件中,关键信息加密保存(哈希函数),并且提供管理工具,而不是手工修改该文件。
3、程序规范
(1) 书写格式
用分层缩进的写法显示嵌套结构的层次。
在注释段与程序段,以及不同逻辑的程序段之间插入空行。
每行只写一条语句,当需要滚动显示时应该分行书写。
(2)流程控制
流程控制首先应遵守语法规范,且用分层缩进的写法突出显示嵌套的层次结构,例如:
For i = 1 To 100
For j = 1 To 50
For k = 1 To 200
Matrix[i,j,k]=1
Next
Next
Next
(3)注释及格式要求
注释总是加在程序中需要概括性说明或不易令人理解或容易令人理解错的地方。注释语言应简练、易懂而又准确,所采用的语种首选是中文,如有输入困难或特殊需求也可采用英文。
注释原则:
a、函数或过程的注释
在函数头部必须说明函数的功能和参数(值参、变参);
在函数的主体部分,如算法复杂时,应以注释的方式对其算法结构做出说明;
函数申请全局资源且有可能导致资源紧张应加以注明(如内存和文件句柄等);
函数有副作用一定以十分醒目的方式(如加!号等)注明。
b、语句的注释
应对不易理解的分支条件表达式加注释;
不易理解的循环,应说明出口条件(有GOTO的程序还应说明入口条件);
过长的函数实现,应将其语句按实现的功能分段加以概括性说明。
c、制定对象的注释
每个开发人员针对自己所制定的窗口、菜单、数据窗口、数据管道和用户对象等添加注释,要点是:
标注对象的用途;
标注对象的制定人员;
标注时间或者修改时间。
具体格式参考示例如下:
示例1. 在窗口Open事件前应说明
/* ======================================================= */
// 窗口中英文名称:
// 窗口作用:
// 作者:
// 日期:
/* ======================================================= */
示例2. 在事件脚本(Script)之前应说明
/* ======================================================= */
// 脚本作用:
// 输入参数及数据类型:
// 返回参数及数据类型:
// 全局函数及其用途:
// 全局变量及其用途:
联系客服