<< Click to Display Table of Contents >> 导航:  Access开发标准 > Access高手良好习惯 > Access注释规范

 

---

 

       好的注释规范会让你的程序更易读，也让你的程序和代码更专业，并且方便你和整个团队合作开发。是团队开发必须掌握的一项规则。

 

 

 

---

 
       对于变量的注释紧跟在变量的后面说明变量的作用。原则上对于每个变量应该注释，但对于意义非常明显的变量，如：i,j等循环变量可以不注释。
例如： Dim strFormName As String  ‘保存控件所在窗体的名称。

 

请注意：

对于非通用的变量，在定义时最好加以详细注释说明，甚至加上示例或图解。

 

变量定义尽可能放在函数或子程序的最开始处，统一管理。
　

 

---

 

       对于函数，应该从“函数名称”、“功能描述”，“输入参数”，“返回值”、“主要思路”、“调用方法”、“相关函数”、“兼容性”、“作者”、“创建/修改日期”十个方面用如下格式注释，如果需要，还可加上“使用注意”、“参考资料”、“图解”等注释项

 

 
'=================================================================
'-函数名称:         gprocInitXpStyle
'-功能描述:         初始化窗体的XP风格
'-输入参数:         参数1:rstrFrmName String 窗体名称
'-返 回 值:         无
'-调用方法:         gprocInitXpStyle "frmMainMenu"
'-相关函数:         gfuncSetMouseMove gfuncSetMouseDown gfuncSetMouseUp
'-主要思路:         在窗体加载或打开时设置所有控件的的鼠标事件从而实现XP风格
'-使用注意:      只适用Label TextBox CommandButton ComboBox OptionButton CheckBox
'-兼 容 性:         97,2000,XP compatible
'-参考文献:
'-作    者:         王宇虹  修改：王宇虹
'-创建日期;         2002-08-26  更新日期: 2002-08-28
'-图    解:
'===================================================================
 

 

 

 

有些函数，部分参数为可选参数，则需加说明，对于某些意义不明确的参数还要做详细说明（例如：以角度作为参数时，要说明该角度参数是以弧度（PI）,还是以度为单位）。等等。②

如果你的函数参考了别人的代码，则需特别指出原作者及相关链接。尊重别人的成果

函数内各功能模块，如：循环、流程的各分支等，尽可能多地加以注释。

在注释中应该记录函数修改的日期，并详细说明函数的主要实现思路、特别要注明自己的一些独到想法，如果有必要则应该写明对想法产生的来由。

在注释中详细注明函数的适当调用方法，对于返回值的处理方法等。在使用注意中要强调调用时的一些特别需要注意的事项，以及调用可能出现的后果或可能出错的情况。

应保留函数创建日期及中间每次修改的日期。

对函数注释开始到函数命名之间应该有一组用来标识的特殊字符串。

如果算法比较复杂，或算法中的变量定义与位置有关，则要求对变量的定义进行图解。对难以理解的算法能图解尽量图解。

 

模块和类模块的注释

 

'====================================================================
'-（类）模块名称:   modPrint
'-（类）模块描述:     有关打印和预览以及印页面设置的一些公用函数和子程序
'-主要函数与事件:   
'
'-版  本:          模块的版本号，最后完成日期。
'-参考文献:         
'-测试用例:
'-使用注意:         
'-兼容性:           97,2000,XP compatible
'-作者:             王宇虹，改进：王宇虹
'-修改::          说明对模块的修改内容、修改原因以及修改日期
'====================================================================

 

①、 每个模块应尽量只包含某一类型的代码，以方便分类管理和方便注释。

②、 主要的函数和事件应该在模块注释中予以注明，这样别人就不必寻找所有模块的代码就可找到自己需要的函数在哪个模块。
③、 参考文献只需简要说明主要的参考文献，而具体哪个函数参考哪些文献则在函数的注释中再予以说明。

 

 

 

---

 

 

       对ACCESS中的对象，包括表（表的字段）、窗体、报表、模块、数据页、宏等做一个对象级的说明，在未打开这个对象之前，让别人知道这个对象包含什么内容及处理哪些功能。

 

 

 

在这个图中对每个模块和类模添加了一个简要的说明，一旦你的系统越来越大，对象越来越多的时候，这些说明能让你更快地找到你需要的对象。

 

 

 

 

如果你平时与你的同事协同进行开发，而且经常需要相互之间导入导出程序或对象，那么在导入导出过程中，可能这些说明会丢失，为此，我专门写了一个工具（说明导入导出工具），它可以帮助你单独将这些对象的说明导入到一个数据表中，然后在另一个数据库中导入它，当然，这个工具还包括了其它一些非常有用的功能，如果你需要这个工具或对它感兴趣，可到www.access-cn.com中下载

 

说明里的文字的第一个字符也可按照一定的规律来编写，以方便以后的排序和索引

 

 

 

 

---

 

 

在代码当前行的后面，通常会做一些必要的注释，如：

Static sstrCtrNameLast As String '静态变量 用来保存最近一次移动过的控件名称

Dim ctr As Control               '临时变量 用来定义当前控件和最近一次移动过的控件

Dim frm As Form                 '临时变量 用来定义当前的窗体