VB命名规范全面.doc

合集下载

vba命名规则

vba命名规则

vba命名规则VBA(Visual Basic for Applications)是用于在Microsoft Office 应用程序中编写宏的编程语言。

命名规则在编写VBA代码时非常重要,因为良好的命名规则可以使代码更易读、易理解和易于维护。

以下是一些常用的VBA命名规则和相关参考内容。

1. 变量和对象命名:- 使用有意义的名称:变量和对象的名称应该能够清楚地表达其用途或含义。

例如,如果变量用于存储员工的姓名,则可以将其命名为"employeeName"。

- 避免使用缩写和简写:尽量避免使用缩写和简写的命名,因为这可能会降低代码的可读性。

使用完整单词可以更清楚地表达变量或对象的含义。

- 使用小驼峰命名法:变量和对象的名称应该以小写字母开头,并使用小驼峰命名法。

例如,"myVariable"或"myObject"。

2. 过程和函数命名:- 使用动词和名词:对于过程和函数,应该使用动词和名词来描述其功能。

例如,如果函数用于计算两个数字的和,则可以将其命名为"calculateSum"。

- 使用帕斯卡命名法:过程和函数的名称应以大写字母开头,并使用帕斯卡命名法。

例如,"CalculateSum"或"GetEmployeeName"。

3. 常量命名:- 使用全大写字母:常量的名称应该使用全大写字母,并使用下划线分隔单词。

例如,"MAX_VALUE"或"DEFAULT_WIDTH"。

- 使用有意义的名称:常量的名称应该能够清楚地表达其含义或用途。

例如,如果常量用于定义界面的宽度,则可以将其命名为"INTERFACE_WIDTH"。

4. 规范命名前缀:- 使用前缀表示变量类型:为了更清楚地声明变量的类型,可以使用特定的前缀来表示变量的数据类型。

vba 命名基本规范

vba 命名基本规范
窗体(子窗体)
fsfr
_SubForm
报表(子报表)
rsrp
_SubReport
查询(SQL传递查询)
qspt
_PassThru
查询(总计查询)
qtot
_Totals
查询(联合查询)
quni
_Union
查询(更新查询)
qupd
_Update
窗体/报表(类型)
窗体(任何类型)
frm
窗体(对话框)
fldg
_Dialog
窗体(菜单)
fmnu
_Menu
窗体(消息框)
fmsg
_Message
操作(DoCmd)
dcm
应用程序(Application)
app
命令栏(CommandBar)
cbr
引用(Reference)
ref
当前拥有焦点对象(Screen)
scr
命令(Command)
cmm
连接(Connection)
cnn
数据库容器(Container)
cnt
数据库(Database)
dbs
字段(类型)
自动编号(随机)
idn
自动编号(顺序)
ids
自动编号(同步复制ID)
idr
是/否
ysn
字节
byt
整型
int
长整型
lng
单精度型
sng
双精度型
dbl
同步复制ID
uid
小数
dcm
货币
cur
日期/时间
dtm
文本
chr
备注
mem
OLE对象

vba变量名命名规则

vba变量名命名规则

vba变量名命名规则
在VBA编程中,变量名的命名需要遵循一定的规则,以保证代码的可读性、可维护性和可扩展性。

以下是VBA变量名命名规则的具体内容:
1. 变量名必须以字母开头,不能以数字或特殊字符开头。

2. 变量名可以由字母、数字和下划线组成,不能包含空格和其他特殊字符。

3. 变量名长度应该控制在可读性和易记性范围内,通常建议不要超过20个字符。

4. 变量名应该避免使用保留关键字,如If、Then、Else等。

5. 变量名应该尽可能地表达变量的含义,以便于他人阅读和理解。

6. 变量名的大小写应该保持一致,建议使用驼峰命名法或下划线命名法。

7. 变量名应该具有良好的可读性,可以使用缩写或简写,但必须具有明确的含义。

8. 变量名应该避免使用拼音或外语单词,以便于不同语言环境下的阅读和理解。

总之,在VBA编程中,良好的变量命名规则可以提高代码的可读性和可维护性,也有助于减少代码错误和资源浪费。

因此,程序员应该在变量命名时认真考虑,遵循上述规则进行命名。

- 1 -。

vba命名规则

vba命名规则

经常使用Access的朋友,要是不规范命名规则,很容易自己搞混淆;本文转载介绍了一下VB命名规则,由于Access跟vb基本语法类似,这里就整理成技巧供初学者查看:Access及VB编程控件及变量命名规则一、常用控件的命名:控件类型前缀例子Form frm frmMainMenu mnu mnuFileOpenLabel lbl lblHelpMessageCheck box chk chkReadOnlyCombo box cbo cboEnglishCommand button cmd cmdExitCommon dialog dlg dlgFileOpenData grid dgd dgdTitlesDate picker dtp dtpPublishedDirectory list box dir dirSourceDrive list box drv drvTargetFile list box fil filSourceADO Data ado adoBiblioFrame fra fraLanguageHierarchical flexgrid flex flexOrdersImage img imgIconImageList ils ilsAllIconsList box lst lstPolicyCodesListView lvw lvwHeadingsMonth view mvw mvwPeriodMS Chart ch chSalesbyRegionMS Flex grid msg msgClientsMS Tab mst mstFirstOLE container ole oleWorksheetOption button opt optGenderPicture box pic picVGAProgressBar prg prgLoadFileRichTextBox rtf rtfReportStatusBar sta staDateTimeTabStrip tab tabOptionsText box txt txtLastNameToolbar tlb tlbActionsTreeView tre treOrganization二、变量命名数据类型前缀例子String (字符串类型) str strFNa meInteger (短整数类型) int intQua ntityLong (长整数类型) lng lngDist anceSingle (单精度浮点数类型) sng sngAvera geDouble (双精度浮点数类型) dbl dblTolera nceBoolean (布尔类型) bln blnFou ndByte (字节类型) byt bytRa sterDataDate (日期类型) dte dteNo wCurrency (货币计算与定点计算类型) cur curRevenu eObject (东西类型) obj objCurrentVariant (变体类型) vnt vntCh eckSum。

VB变量的命名规则

VB变量的命名规则

VB变量的命名规则VB变量的命名规则(1)变量的名必须是字母或文字开头,而不能使用数字或其他字符开头(2)变量名不能含有小数点、空格(3)变量名的总字数不能超过255个(4)不能含有VB的专用保留字,在VB中有特殊意义的单词、字母组合。

例如:Print 、sub 、end 、click等(5)VB不区分大小写VB中常用的数据类型一、数据类型概述数据:计算机能够处理数值、文字、声音、图形、图像等信息,均称为数据。

数据类型:根据数据描述信息的含义,将数据分为不同的种类,对数据种类的区分规定,称为数据类型。

数据类型的不同,则在内存中的存储结构也不同,占用空间也不同VB的基本数据类型:数值型数据(主要数据类型)日期型字节型货币型逻辑型字符串型对象型变体型二、数值数据类型数值类型分为整数型和实数型两大类。

1、整数型整数型是指不带小数点和指数符号的数。

按表示范围整数型分为:整型、长整型(1)整型(Integer,类型符%)整型数在内存中占两个字节(16位)十进制整型数的取值范围:-32768 ~ +32767例如:15,-345,654%都是整数型。

而45678%则会发生溢出错误。

(2)长整型(Long,类型符&)长整数型在内存中占4个字节(32位)。

十进制长整型数的取值范围:-2147483648 ~ +2147483647例如:123456,45678&都是长整数型。

2、实数型(浮点数或实型数)实数型数据是指带有小数部分的数。

注意:数12和数12.0对计算机来说是不同的,前者是整数(占2个字节),后者是浮点数(占4个字节)实数型数据分为浮点数和定点数。

浮点数由三部分组成:符号,指数和尾数。

在VB中浮点数分为两种:单精度浮点数(Single )双精度浮点数(Double )(1)单精度数(Single,类型符!)在内存中占4个字节(32位),,有效数字:7位十进制数取值范围:负数-3.402823E+38 ~ -1.401298E-45正数 1.401298E-45 ~ 3.402823E+38在计算机程序里面不能有上标下标的写法,所以乘幂采用的是一种称为科学计数法的表达方法这里用E或者e表示10的次方(E/e大小写都可以)比如:1.401298E-45表示1.401298的10的负45次方vb里面可以这样表示:8.96E-5例:21e5(正号省略)表示:21乘以10的5次方的一个单精度数(2)双精度数(Double,类型符#)Double类型数据在内存中占用8个字节(64位)Double型可以精确到15或16位十进制数,即15或16位有效数字。

VBA命名规则及代码规范

VBA命名规则及代码规范

VBA 命名规则及代码规范1. VBA 命名规则一个好的命名规则可以提高程序的可读性,减少错误发生的概率,命名规则不是一定的,不同 的人有不同的规则和习惯, 但在编程过程中, 对于个人或工作组, 一定要遵守相同的命名规则. 1.1. 变量,常量, 变量,常量,自定义类型和枚举表 1-1 概括了变量,常量的基本命名规则.表 1-1 变量,常量和枚举类型的命名规则元素 变量 常量 用户自定义类型 命名规则 <范围><数组><数据类型>描述(首字母大写) <范围><数据类型>描述(全部大写) Type 描述名称 <数据类型>描述 End Type 枚举类型 Enum <工程前缀>一般描述 <工程前缀><一般描述><具体名称 1> <工程前缀><一般描述><具体名称 2> End Enum<范围>表示了变量的作用域,对于 Private 类型和模块级变量,一般使用"m"前缀表示, 对于 Public 类型的变量,一般使用"g"前缀表示,而对于过程内的局部变量,则不使用前缀. 如果是数组,在范围前缀后增加"a"表示变量为数组. 对于数据类型,一般使用表 1-2 的前缀表示.表 1-2 命名规则常用前缀前 缀 is byt Boolean Byte 数据类型 前 缀 cm cn mand ADODB.Connection 数据类型 前 缀 cmb chk boBox MSForms.CheckBox 数据类型cur dte dec f i obj str uCurrency Date Decimal Double,Single Integer,Long Object String User-defined typersADODB.Recordsetcmd framandButton MSForms.Frame bel MSForms.ListBox MSForms.MultiPage MSForms.OptionButton MSForms.SpinButton MSForms.TextBoxcht rng wb wsExcel.Chart Excel.Range Excel.Workbook Excel.Worksheetlbl lst mpg opt spncbrmandBartxtv colVariant VBA.Collectionctl clsmandBarControl 自定义类ref frmRefEdit Control 用户窗体变量的描述部分最好使用有意义的字符串,使用 1-2 个英文单词表示,首字母大写,例如 "strUserName","iPeopleAge".除了循环变量使用 i,j,临时变量使用 tmp 之类的 变量外,不要使用太短的命名,但也不要使用太长不易记忆的名称. 常量则一般使用全部大写的方式,以与变量区别. 对于枚举类型,整个工程一定要使用一致的规则,每个枚举常量都包含工程前缀,变量前缀和 本身描述几部分,例如: Private Enum schDayType schDayTypeUnscheduled schDayTypeProduction schDayTypeDownTime schDayTypeHoliday End Enum 1.2. 过程和函数过程和函数命名一般使用"名词 + 动词"的方式,首字母大写,也可以使用"动词 + 名词" 方式,对于过程和函数的参数,命名方式见前,为了和局部变量区别,可以不使用表示参数变 量类型的前缀.例如,我们可以命名如下的过程: GetUserName(id as long) As String 1.3. 模块, 模块,类模块和用户窗体模块使用类似过程的命名,用几个表示其用途的首字母大写的短语来表示,例如 "PlotChartTools";类模块增加前缀"C",以与标准模块相区别,例如"CIniTools", "CEmployee"等;用户窗体则以"frm"为前缀,如"frmAbout","frmRegTools". 这样,在代码中我们可以这样使用类模块: Dim clsMyClass As CMyClass Set clsMyClass = New CMyClass 类模块与其对象差别一目了然.由于 VBA 对于窗体可以使用缺省窗体,不需要创建实例,在 代码中可以直接使用,因此,使用了与变量定义一样的前缀.例如: frmRegTools.Show 1.4. VBA 工程VBA 工程一般使用与其文件名同名的名字, 一方面, 当打开几个工程的时候可以方便的区分工 程,另一方面,在工程之间引用的时候,需要不同的名称.2. VBA 代码规范代码规范表示了如何定义变量,过程,函数(见前),如何组织代码,控制缩进,添加注释等 内容.代码规范的目的在于产生一致的代码,提高代码的可读性,使其易于修改和交流.以下 规范并非必须遵守,当使用规范破坏了代码的可读性,那么就没有必要遵从代码规范了,这种 情况需要自行判断. 2.1. 代码的排版缩进 一般来说,代码的缩进应该为 4 个空格,在 VBA IDE 中选中自动缩进,并设置为 4 个字符. 一个过程的语句要比过程名称缩进 4 个空格,在循环,判断语句,With 语句之后也要缩进. 例如: If strText = " " Then NoZeroLengthString = Null ElseNoZeroLengthString = strText End If 行的长度 一行代码尽量不要过长, 对于大多数编程规范, 建议一行代码的最大长度为 80 个字符, VBA 在 中,可以使用续行赋"-"将长的代码行分为数行,后续行应该缩进以表示与前行的关系.例 如: AverageValue = TotalValue / _ Worksheet(1).Range(〃A1:A1000〃).Rows.Count 空行 一个模块内部,过程之间要使用空行隔开,模块的变量定义和过程之间也应该空 1 行.过程内 部, 变量定义和代码应该空 1 行. 在一组操作和另一组操作之间也应该空 1 行显示其逻辑关系. 空行可以很好的提高程序的可读性,但同时,空行没有必须遵守的规则,其使用的目的就是要 显示程序的逻辑关系. 不要将多个语句放在同一行上 虽然 VBA 允许将多条语句放在一行,但不推荐这么做. 2.2. 注释书写程序的同时,应该同时对关键代码,模块,过程增加注释,更改程序的同时,必须同时更 改注释.必须时刻保证注释与程序代码一致,否则还不如不加注释.对于简短的注释,不需要 加句号,否则应该增加句号,组成段落. 如果可能, 建议尽量使用英文书写注释, 因为这样会带来交流的便利, 特别是在正式的开发中. 区块注释 区块注释通常描述其下的部分或全部代码,例如模块说明或者过程说明.其缩进要和它所描述 的代码一致.模块的注释应该位于模块的所有代码之前,Option 语句之后,过程的注释位于 过程定义之后,并保证缩进一致.对于模块的注释,注释结束后应该有一空行,其前后可以加 一些修饰以区别与其他注释,而过程注释则不需要.例如: #001 Option Explicit#002 #003 '*************************************************** #004 '主程序模块,提供按钮调用,对话框弹出等服务 #005 '*************************************************** #006 #007 Public Const strVer As String = "0.31" #008 #009 Public Sub GeoDrawMain() #010 '主程序模块,单击按钮后弹出 #011 frmMain.Show vbModal#012 End Sub 行内注释 行内注释的形式是在语句的同一行中加注释,行内注释应该简单明了,并不要描述显而易见的 事情.行内注释和语句至少应该有 2 个以上空格.可以在语句和注释之间使用多个 Tab 使注 释对齐,例如: Dim iAge As Long Dim strName As String 2.3. 程序版本 '姓名 '年龄建议在模块注释中包括作者,修改时间,版本等信息,例如: ' 模块名称:气压计算模块 ' 描述:… ' 作者:Mars ' 创建时间:2004 年 4 月 23 日 ' 修改时间:2005 年 7 月 13 日 ' 版本:2.5 此类注释应该形成自己的风格,在所有的工程中保持一致.对于团队工作和正式开发,应该严 格要求在模块注释中包括这些内容.2.4.一些基本原则明确说明作用范围 在代码中,对于模块级的变量,过程,函数,应该总是使用"Public","Private"等关键 字明确说明其范围. 使用有意义的名称 一定要使用有意义的名称,而不要使用简单的 A,B,C 之类的名称(循环变量约定俗成使用 i,j 等名称除外). 明确参数和变量的数据类型 在定义过程参数的时候,一定要明确指定其数据类型和传递方式(ByRef 或者 ByVal),这不 仅仅是考虑效率,而是为了方便对这些过程的使用.对于变量定义,也应该养成明确说明其数 据类型的习惯. 模块内的过程排序 模块内部的过程应该按照"Public","Private"的顺序排序,公有的过程在前,私有在后; 然后再按照过程名称字母顺序排序. 使用常量和枚举 应该尽量使用常量和枚举,而不要在程序代码中使用数字(幻数). 语句的选择 对于 True,False 的判断,使用 If 语句,对于多种可能的判断,使用 Select 语句.对于循环, 对于确定循环次数的循环, 使用 For 语句, 对于不确定循环次数的循环, 使用 Do While 语句, 尽量对集合使用 For Each 语句. Goto 语句 除了错误处理,不要使用 Goto 语句.。

VB命名规则和语法规则1

VB命名规则和语法规则1

软件教研室
三、常量与变量
(3) 变量的作用域
一个变量被定义后并不是在任何地方都 能被引用的,每一个变 量都有它的作用域。 变量的有效范围即是变量的作用域。 VB应用程序由3种模块组成,即窗体模块(Form),标准模块 (Module)和类模块(Class)。 根据变量的定义位置和所使用的变量定义语句的不同,VB中 的变量可分为3类: 1、局部变量 2、模块变量(窗体变量和模块变量) 3、全局变量
重庆信息工程学院
软件教研室
二、数据类型
例子:
定义一学生类型,其中包括“学号”、“姓名” ,“年龄“三个元素。 Private Type Student Num As String*20 Name As String*20 Age As Integer End Type
重庆信息工程学院
软件教研室
三、常量与变量
重庆信息工程学院
软件教研室
三、常量与变量
2、变量
程序在执行过程当中可以变化的量称为变量。 (1)变量的命名规则: ①以字母或汉字开头。 ②从第二个字符开始可以是字母、汉字、数字、下划线,最后 一个字符可以是类型说明符。 ③不能用VB的关键字作为变量名。 ④变量名最多255个字符。 ⑤变量名不区分大小写。
第三章 VB程序设计基础
一、VB命名规则和语法规则 二、数据类型 三、常量与变量
四、常用函数
五、运算符和表达式
重庆信息工程学院
软件教研室
一、VB命名规则和语法规则
1、命名规则:
在利用VB进行程序设计的过程中,需要对变量、控件等进 行引用,而在引用的过程当中就需要用到变量或控件的名称, 所以我们就需要对它们进行命名,命名规则如下: 1)名称的第一个字符必须是字母或汉字; 2)从第二个字符开始可以是字母、数字、汉字、下划线, 不能是空格、句点(.)等其它特殊符号; 3)名称的长度不能超过255个字符; 4)不能与VB的关键字同名;

vb循环变量名

vb循环变量名

VB循环变量名1. 引言在VB(Visual Basic)编程中,循环是一种重要的程序结构,用于重复执行一段代码块。

循环变量名是在循环中使用的变量名,它在每次循环迭代时都会被更新。

选择合适的循环变量名对于代码的可读性和维护性至关重要。

本文将介绍VB循环变量名的命名规范、常见的命名约定以及一些最佳实践。

2. VB循环变量名的命名规范在VB中,循环变量名应遵循一般的命名规范。

以下是一些常见的规范:•变量名应具有描述性,能够清晰地表达其含义。

•变量名应使用有意义的单词或缩写,避免使用无意义的字母或数字。

•变量名应该以字母开头,不应包含空格或特殊字符。

•变量名应该使用驼峰命名法(Camel Case),即首字母小写,后续单词的首字母大写,例如loopCounter。

•变量名应该尽量简短,但不要过于简单以至于失去了明确的含义。

3. 常见的循环变量名在VB编程中,有一些常见的循环变量名被广泛使用。

以下是一些常见的循环变量名及其含义:•i:通常用于表示循环的索引,表示整数值,例如For i = 1 To 10。

•j:通常用于嵌套循环的索引,表示整数值,例如For i = 1 To 10: For j =1 To 5。

•k:通常用于嵌套循环的索引,表示整数值,例如For i = 1 To 10: For j =1 To 5: For k = 1 To 3。

•counter:通常用于计数循环的计数器,表示整数值,例如For counter = 1 To 100。

•index:通常用于表示数组或集合的索引,表示整数值,例如For index = 0 To array.Length - 1。

•row、column:通常用于表示二维数组的行和列,表示整数值,例如For row = 0 To 9: For column = 0 To 9。

这些常见的循环变量名具有良好的可读性和易于理解的含义,因此被广泛接受和使用。

4. 最佳实践除了常见的循环变量名之外,以下是一些最佳实践,可以帮助您选择合适的循环变量名:4.1 使用具有描述性的变量名选择具有描述性的变量名可以提高代码的可读性和可维护性。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

命名工程ActiveX控件和DLL工程命名格式为(….Lib),EXE工程直接命名,如果是通用组件工程,直接命名,如果是项目或产品工程,则使用项目或产品缩写作为前缀。

如:XWY….Lib。

工程命名不必缩写,为了表达意思和用途,可以尽可能地长,而且命名格式采用(名词) 、(形容词+ 名词) 或(名词+ 动作的名词形式)。

如:XWYStockOperationLib或XWYStockLib。

(注意:在任何时候,不要使用中文命名,包括文件夹,文件名,函数名,变量名。

除非文件需要和用户交互!)变量变量命名不推荐采用匈牙利命名法,除非命名会和关键字产生冲突的时候,才采用类型缩写+变量实名的匈牙利命名法。

一般情况下,变量命名应该简单,尽量使用缩写。

如果是类对象或自定义类型对象,则在单一使用情况下使用类名称或自定义类型名称的简写来命名:Dim em As EnityManager如果非单一使用,则使用类型名称缩写为前缀,即使用匈牙利命名法:Dim emRead As EntityManagerDim emSave As EntityManager(注意:所有前缀都全部小写,后面的单词首字母大写)缩写规则如下:如果名称由多个单词组成,则取每个单词的首字母,如EntityManager缩写为em,ProcedureManager缩写为pm。

如果名称由一个单词组成,则对单词进行分段取首字母,如Entity缩写为et。

缩写应该控制在3个字母以内,尽量清晰,对于接口名称,I……中的I前缀不对缩写产生任何影响,如Ientity的名称应视作Entity。

除非首字母为元音,否则应该截取辅音做为缩写,如TextBox控件的缩写前缀为txt。

范围标识:全局变量加前缀:’g_’模块级变量加前缀:’m_’过程级变量不加前缀全局变量和模块级变量应该尽量使用全名称,不推荐使用缩写,如:g_EntityManager 控件控件命名一律使用控件类型缩写+控件用途的命名方式,类型缩写应控制在3个字母以内,缩写规则同变量命名,以下是常用控件的类型缩写,应该严格遵守,如果使用了新的控件,则首先应该在小组内协同一致其类型名称缩写后再进行使用。

cmb Combo boxchk Checkboxcmd Command buttondlg Common dialog controldt DTPicker DropDateControlenm EnumEditBoxfra Framefrm Formgra Graphgrd EditGrid MSHFlexGrid FlexGrid DataGridimg Image ImageListlab Labelln Linelst List boxlv ListViewmnu Menu controlnm NumEditBoxopt Option buttonpic Picturerpt Reportsbr Scroll barshp Shapespn Spinst StatusBartb ToolBartmr Timertxt Textboxtv TreeView函数此处函数包括sub和function,以下这两种过程统称为函数。

函数表示的是一个动作,所以它的结构应该是动词+名词,动词必须小写,后面的名称首字母大写,如:getMaterialCodeupdateGridreadOrder函数命名尽量不要使用缩写,而且它的名称应该使人一目了然,能够从名称就知道这个函数的功能,不要使用无意义的函数名称,如:getCode(当这个函数属于Materail类的时候,它还是有意义的),update,readData。

当函数名称不足以表达其功能时,使用在函数头部加上让调用者足够明白的注释。

参数的命名:参数命名的原则是全部小写,如果参数包括两个或以上的单词时,首单词字母小写,其它单词首字母大定,如showCol、isUpdate。

常量常量的命名应该全部大写,使用’_’作为单词间的分隔符,单词尽量使用全名称,如:Public Const MSG_EMPTY_ROW As String = “有空行存在!”解释:(1)对一些常用词应该使用简写,如msg(2)使用Public而不是早期版本的global来声明变量(3)对常量的声明必须带上类型,如上面的As String属性属性的命名采用首字母大写的原则,如ItemCount Item类、窗体和模块类的命名使用功能名词,不必加任何前缀和后缀,并且单词首字母大写,如:SystemConfig窗体命名使用功能名词+ Form后缀,如:ListForm。

但对于单据的明细窗体则统一使用Detail后缀替换Form模块命名:不必加任何前缀和后缀,直接命名自定义控件自定义控件的命名:名词+ Ctrl如:EditGridCtrl格式定义定义的代码块应该放在一起,尽量不要在中间定义变量,变量的定义应该顶行进齐,不能缩进,同时要保证”As”关键字的对齐,如下:Dim i As IntegerDim j As IntegerDim em As EntityManager对象的定义应该尽可能地带上所属的库名称,防止以后引起名称冲突,如引用了两个Lib,每个中都包含一个stock类,如果不使用As ….Lib.Stock的定义方式,则无法编译通过,为了防止以后程序扩充和修改时引入新的库带来命名冲突,推荐在定义类对象时全部加上库标识,对于本工程的类对象定义也要加上,如:Dim em As ObjectPersistenceLib.EntityManager空行空行是区分代码块与块的间隔,在函数之间必须加上空行(两行左右),而函数内部,变量声明块和实现块(实现块指除变量声明外的其它代码)要使用空行来间隔(一行),实现块的内部,通过空行来标识一个功能段,如:Private Sub Check(Order As NYSaleBackLib.Order)'* 减少库存Dim objStockItem As NYStockLib.StockItemDim objStock As NYStockLib.StockDim i As IntegerSet objStock = CreateStock()For i = 0 To Order.ItemCount - 1Set objStockItem = Order.item(i)'* 减少库存Call objStock.ReduceItem(objStockItem, True)Next iSet objStock = NothingEnd Sub(注意:不要使用过多的空行,空行太多影响代码阅读!)缩进缩进必须严格执行,变量声明块不缩进,实现块必须保证全部缩进(即不可能有实现块是行首对齐的)。

对于基本的控制结构,必须要有缩进,如:IF、DO、WITH、FOR、OPEN、SELECT 块,缩进示例如下:…..If ….. Then…..End If…..(注意:在任何地方,不要写ElseIf语句,转换成IF..ELSE..ENDIF结构)对于过长的语句,必须使用续行,续行位置要有明显意义,示例:sql = “SELECT [code],[name] FROM [Person] “ _& “ WHERE [code] LIKE ‘001%’ “函数的参数如果过长,也应该续行,示例:'**'增加库存'@param ProductCode 产品编号'@param Spec 长度规格'@param Color 颜色'@param Patch 是否拼圈'@param V olumn 盘号'@param Ordinal 子库存顺序号'@param Length 长度'@param IsCheck 是否审核入库增加(否则为弃审出库增加)Public Sub AddDetail(ProductCode As String, _Spec As Double, _Color As String, _Patch As Boolean, _V olumn As String, _Ordinal As Integer, _Length As Double, _IsCheck As Boolean)注释量注释以尽可能少为宜,但必须要做到别人能够通过阅读你的代码明白你的意思,让调用者明白函数功能的表达优先级原则如下:(1)通过函数名称表达(2)通过代码来表达(3)通过注释来表达由上可知,注释是在代码无法充分表达函数功能时才提供,注释同样应该做到准确简洁。

格式注释的格式遵循vbDocMan的写法,一般情况下使用vbDocMan的注释编辑器进行注释编写,对于显而易见的参数或函数功能可以不加注释。

参数注释中参数类型可以不要。

示例:'**'读取单据信息'@param OrderID 单据号'@param Order 单据Private Function ReadOrder(OrderID As String, Order As NYSaleBackLib.Order) As BooleanEnd Function在每个代码模块(窗体、类、模块、控件)的最上面,必须写上代码编写人(使用英文名或中文拼音缩写)、代码创建时间、代码修改时间和修改说明。

示例:'**'库存修改类'@writer pureach'@createdate 2003-11-12'@revision pureach 2003-11-15'增加对库存修改时同时影响最后入库日期的功能什么是好的代码(1)可读性很强的代码格式,能够区分不同的代码块(2)清晰明了的命名,在尽可能短的名称长度下传递足够多的信息(3)和代码相得益彰的注释(不要让注释重复代码所能表达的信息)(4)变量的生存期尽可能地短,这样阅读者不用去记大量的变量声明(5)使用小函数,将功能复杂的大函数进行分隔总之,代码的好坏应该让别人是否能够容易读懂来区分,如果对自己的代码不满意,那么先给别人阅读,然后让阅读者告诉你他为什么读不懂,哪些地方读着吃力。

好的代码应该能够让你在几个月后回顾自己的代码时一目了然(架构的清晰是代码易读的前提)。

相关文档
最新文档