VB程序编码规范
- 格式:doc
- 大小:41.00 KB
- 文档页数:2
VB编码规范VB编码规范 (1)1 目的 (1)2 适用范围 (1)3 规范内容 (2)3.1 最低限制的编程规约 (2)3.2 对象的命名基准 (2)3.3 控件的前缀 (2)3.4 数据访问对象(DAO,ADO)的前缀 (3)3.5 菜单的前缀 (4)3.6 其他控件前缀的选择 (4)3.7 常量和变量的命名基准 (5)3.8 变量的有效范围 (5)3.9 变量有效范围的前缀 (5)3.10 常量 (6)3.11 变量 (6)3.12 变量的数据类型 (6)3.13 说明变量和过程用途的名字 (7)3.14 用户自定义类型 (7)3.15 代码编写规约 (7)3.16 代码注释规约 (7)3.17 代码的形式 (8)3.18 常量的分组化 (9)3.19 & 运算符和+ 运算符 (9)3.20 MsgBox、InputBox、以及SQL 查询字符串的作成 (9)1目的规范ASP代码编写人员的编程工作。
2适用范围本规约是科大量星的基本编程规约,用于Visual Basic编程。
编程规约不是程序的逻辑,而是作为统一程序的物理结构和外观的基准规约。
编码是如果遵守编程规约,那么代码的阅读理解和维护都将会变成一种乐趣。
编程规约的内容如下:工程,变量以及过程的命名基准代码的惯用标签和注释的标准形式间隔,记述形式以及缩进编程规约设定的理由是,如果一贯使用某种编程规约,应用程序的风格和结构都是标准化的,代码将很容易理解和维护。
3规范内容3.1最低限制的编程规约作为通用的编程规约,规定最低限制的必要条件。
为实现这个目标,同时也是为了程序,程序的逻辑以及车工序的流程能自由的做成。
该规约推荐的基准是一个简单的参考,没有提供对全部的对象和控件的规定。
另外也没有规定注释的全部类型。
对应于工程和组织的各自要求条件,添加以下的要素作为基准:公司内部开发的或由第三方处购入的特殊对象和控件的命名基准表示组织的事业内容和设施的变量名对于工程和公司,容易理解和容易阅读作为一个重要的要素考虑赋予对象具有一个一惯性使用的前缀的名字,对于方便容易的理解对象的种类是必要的。
VB编码规范必须打开设置选项的”要求变量声明”,”对齐控件到网格”,”自动缩进”开关。
Tab的宽度统一为4个空格,网格单位一律设为:width 50 height 50。
命名工程ActiveX控件和DLL工程命名格式为(….Lib),EXE工程直接命名,如果是通用组件工程,直接命名,如果是项目或产品工程,则使用项目或产品缩写作为前缀。
如:XWY….Lib。
工程命名不必缩写,为了表达意思和用途,可以尽可能地长,而且命名格式采用 (名词) 、 (形容词 + 名词) 或 (名词 + 动作的名词形式)。
如:XWYStockOperationLib或XWYStockLib。
(注意:在任何时候,不要使用中文命名,包括文件夹,文件名,函数名,变量名。
除非文件需要和用户交互!)变量变量命名不推荐采用匈牙利命名法,除非命名会和关键字产生冲突的时候,才采用类型缩写+变量实名的匈牙利命名法。
一般情况下,变量命名应该简单,尽量使用缩写。
如果是一般的值类型,如integer string,则直接使用变量用途命名,尽量使用全名:Dim name As StringDim count As Interger对于一般的临时性变量定义,应该尽可能地简单,如:Dim i As IntegerFor i = 0 to 100Next I如果是类对象或自定义类型对象,则在单一使用情况下使用类名称或自定义类型名称的简写来命名:Dim em As EnityManager如果非单一使用,则使用类型名称缩写为前缀,即使用匈牙利命名法:Dim emRead As EntityManagerDim emSave As EntityManager(注意:所有前缀都全部小写,后面的单词首字母大写)缩写规则如下:如果名称由多个单词组成,则取每个单词的首字母,如EntityManager缩写为em,ProcedureManager缩写为pm。
如果名称由一个单词组成,则对单词进行分段取首字母,如Entity缩写为et。
VB代码规范第 1 页共 13页编号:YH-Q-长沙XXXXXX有限公司页号:1/13软件开发标准版次:A 第0次修改文件起草部门研发部标题, 批准人 Visual Basic 编码标准批准日期2008.5.8第一章命名约定 ..................................................................... .................................................. 2 第二章代码布局格式约定 ..................................................................... ................................... 3 第三章类型使用约定 ..................................................................... ........................................... 4 第四章表达式约定...................................................................... .............................................. 4 第五章控制结构约定 ..................................................................... ........................................... 4 第六章函数及操作符使用约定 ..................................................................... ............................ 4 第七章模块及访问约定 ..................................................................... ....................................... 4 第八章注释使用约定 ..................................................................... ........................................... 5 第九章错误处理约定 ..................................................................... ........................................... 5 第十章其它 ..................................................................... . (6)第 2 页共 13页第一章命名约定1(虽然在VB中对字母大小写不敏感,本规定要求在程序设计编码过程中,一律按字母大小写敏感处理。
5、程序编码规范
变量命名约定
前台VB程序变量约定,变量名由前缀和中文名称组成,即:AB变量名,其中A 表示该变量的范围即:
后台Oracle存储过程,函数以及触发器也可能使用到变量,与VB程序约定一致,如:
⏹VB过程命名约定
由于VB的过程不返回任何值,因此在过程名前加动词Do,代表要做一件事,如:Private Sub Do设置窗口颜色(vl颜色值 As Long)
……
End Sub
⏹VB函数命名约定
由于VB的函数除了要处理一件事或做一个计算外,还要返回一个值,因此在函数名前加动词Get ,代表要得到一个值,如:
Private Sub Get得到拼音简码(vs中文字串 As String)
……
End Sub
⏹Oracle 存储过程约定
Oracle 存储过程通常要处理一件事,并且要通过一个参数返回一个结果,每个存储过程名前加入Do,如:
CREATE OR REPLACE PROCEDURE Do出库单审核
( vs操作类型 In nvarchar2,
vl单据序号 In numeric,
vl同步序号 In numeric,
vl操作员 In numeric,
ps处理成功 Out nvarchar2,
ps失败描述 Out nvarchar2
)
IS
Begin
……
ps处理成功:='是';
End Do出库单审核;。
VB_编码规则范文VB编码规则是为了确保VB代码的一致性、可读性和可维护性而制定的一系列准则。
以下是一些常见且重要的VB编码规则。
命名规则:1.使用有意义的命名:变量、函数和过程等的命名要具有描述性,能清晰地表达其功能和用途。
2. 使用有意义的前缀:使用具有描述性的前缀来标识变量的类型,如使用"int"表示整型变量。
3.避免使用缩写:尽量避免使用缩写或缩写的单词,以提高代码的可读性和可理解性。
4.保持命名一致性:保持命名的一致性,例如使用驼峰命名法或下划线命名法,并在整个代码中保持一致。
代码布局和格式:1.使用适当的缩进:使用适当的缩进,使代码的结构清晰可读。
2.使用空格和空行:在代码之间使用适当的空格和空行,以提高代码的可读性。
3.注释代码:为代码添加注释,解释其功能和用途,以便其他人能够理解和维护代码。
4.使用合适的代码折行:在代码过长时使用适当的折行,使每一行的代码长度适中,提高可读性。
规范和最佳实践:1. 使用明确的错误处理:在代码中使用适当的错误处理机制,如使用Try-Catch语句来捕获异常。
2.避免使用全局变量:尽量避免使用全局变量,减少变量的作用域,提高代码的可维护性。
3.优化性能:合理使用循环、条件语句和函数调用,提高代码的性能。
4.遵循单一职责原则:每个过程和函数都应该有单一的责任,并遵循单一职责原则。
以上只是VB编码规则的一部分,具体的编码规则还需要根据项目的实际情况和团队的约定来制定。
编码规则的遵循可以提高代码的质量,减少错误和Bug,并提高代码的可读性和可维护性,使代码更易于理解和修改。
第三章 VB的程序设计基础[日期:2005-09-09] 来源:作者:[字体:大中小]2.1VB编码规则1.语言元素VB的语言基础是BASIC语言,VB程序的语言元素主要由:关键字(如:Dim、Print、Cls)函数(如:Sin()、Cos()Sqr())表达式(如:Abs(-23.5)+45*20/3 )语句(如:X=X+5 、IF……ELSE……END IF)等组成。
2.VB代码书写规则(1)程序中不区分字母的大小写,Ab 与AB等效;(2)系统对用户程序代码进行自动转换:1)对于VB中的关键字,首字母被转换成大写,其余转换成小写2)若关键字由多个英文单词组成,则将每个单词的首字母转换成大写3)对于用户定义的变量、过程名,以第一次定义的为准,以后输入的自动转换成首次定义的形式3.语句书写规则(1)在同一行上可以书写多行语句,语句间用冒号(:)分隔(2)单行语句可以分多行书写,在本行后加续行符:空格和下划线 _(3)一行允许多达255个字符4.程序的注释方式(1)整行注释一般以Rem开头,也可以用撇号';(2)用撇号' 引导的注释,既可以是整行的,也可以直接放在语句的后面,最方便;(3)可以利用“编辑”工具栏的“设置注释块”、“解除注释块”来将设置多行注释。
5.保留行号和标号VB源程序接受行号与标号,但不是必须的(早期的BASIC语言中必须用行号)。
标号是以字母开始以冒号结束的字符串,一般用在GOTO语句(现在很少用)中。
2.2VB的语言基础1.数据类型VB的标准数据类型注意:1)VB中对没有声明的变量其缺省的数据类型是变体型,可以用来存储各种数据,但所占用的内存比其它类型都多。
为提高运行效率(整型效率较高),或达到一定的运算精确度(浮点型精度较高,但运行较慢),应合理的定义数据类型。
2)逻辑型数据只有True 和False两个值,转换成整型时,True=-1 ,False=0,将其它类型转换成逻辑型时,非0数转换为True ,0转换为False。
VisualBasic编码标准VisualBasic编码标准沈阳东东系统集成有限公司1996年7月目录1.适用 (1)2.目的 (1)3.环境 (1)4.说明4.1 名称的定义方法 (1)4.2 常量 (2)4.3 变量型 (2)4.4 变量名 (2)4.5 index (3)4.6 根据type活用结构说明 (3)4.7 数组的说明 (3)4.8 在实行时,数组大小的决定 (3)4.9 关于Constant.txt (3)5.编码5.1 在编码部的方法和属性 (3)5.2 Cancel 与Default (3)5.3 optionbutton (4)5.4 listbox的初始化 (4)5.5选择按扭 (4)5.6 过程的参数 (4)5.7 利用DLL时的参数 (5)5.8 向textbox的字符串的赋值 (6)5.9 在list/convobox中的ItemData (6)5.10 sizeof (7)5.11 字符串的连接 (7)5.12 向结构内的字符串变量的赋值 (8)5.13 应用程序的2次起动时的检测 (8)5.14 有关日期check函数(IsDate())的注意 (8)5.15 messagebox的mark指定 (9)5.16 有关Trim$的注意 (9)5.17 有关Grid的注意 (9)5.18 关于错误的处理 (9)5.19 进行需时较长的处理时的注意 (10)5.20 在使用FileCopy函数时的注意 (10)6.project6.1 projectfile (10)7.安装7.1 在终端的安装 (11)8.VCP的利用8.1 file选择对话框 (11)8.2 text输入领域框架 (11)8.3 optionbuttonframe框架 (11)8.4 对需时较长处理的进度状况表示 (11)8.5 关于利用VCP的Control的窗体的颜色 (11)9. FEP的control (12)10.cursor移动control]10.1 在return输入时,向下一个输入领域移动 (12)11.textbox选择处理 (13)1.适用本编码规范记录了在编写Visual Basic 的程序时的规范及标准。
VB、VC编码规范目录1.VB 部分 (3)1.1.控件前缀 (3)1.2.数据访问对象(DAO)前缀 (5)1.3.菜单前缀 (5)1.4.其它控件前缀 (6)1.5.变量、常量范围前缀 (6)1.6.变量、常量类型前缀 (6)1.7.描述变量和过程名 (7)1.8.用户定义的类型 (7)1.9.代码注释约定 (7)1.10.窗体隐含全局变量 (9)1.11.命名属性、方法和事件 (9)1.12.常数使用 (9)1.13.MsgBox书写要求 (9)1.14.SQL语句书写要求 (10)1.15.源程序编排 (10)1.16.源文件命名 (11)1.17.资源ID (11)2.VC部分 (12)2.1.C++类的定义形式约定表 (12)2.2.头文件的书写顺序约定表 (12)2.3.源文件的书写顺序约定表 (12)2.4.标识符命名约定表 (13)2.5.函数头说明规范 (13)2.6.修改申明 (13)3.窗体和控件的取名:详见命名标准 (14)4.显式声明变量 (14)5.为便于阅读程序,禁止使用VB的“字符串和数字的自动转化功能” (14)6.在程序中禁止使用END语句 (15)7.为增强可读性,不得使用控件值 (15)8.修改代码注释: (15)在原来有错误的代码前先列出,修改人,修改原因,修改日期;注释原代码,写出新代码,写出新代码结束标志 (15)1.VB 部分1.1.控件前缀1.2.数据访问对象(DAO)前缀1.3.菜单前缀菜单控件除了最前面 "mnu" 标记以外,菜单控件的前缀应该被扩展:对每一级嵌套增加一个附加前缀,将最终的菜单的标题放在名称字符串的最后。
下表列出了一些例子。
当使用这种命名约定时,一个特定的菜单组的所有成员一个接一个地列在Visual Basic 的“属性”窗口中。
而且,菜单控件的名字清楚地表示出它们所属的菜单项。
1.4.其它控件前缀对于上面没有列出的控件,应该用唯一的由两个或三个字符组成的前缀使它们标准化,以保持一致性。
VisualBasic编程规范版本记录:1概述本规范摘编自微软VB程序员手册。
编程规范注重于程序的物理结构和外观,而不是程序的逻辑结构。
使用统一编码约定集合的主要原因,是使应用程序的结构和编码风格标准化,使之容易阅读、容易理解而且容易维护。
‘最小编码约定’是一组通用目的的编码约定,定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。
最小编码约定的目的是使程序易于阅读和理解,而不是用过分的约束和绝对的限制来束缚程序员本身的创造性。
所以本规范提出的约定是简洁和建议性的。
这些约定中没有列出每一个可能的对象或控件,也没有列出每种有用的信息注释。
依据工程及机构的特殊要求,也许需要扩充这些准则,以包含附加的元素,如:Ø对于在家庭中开发的或从第三方厂商购买的特定对象及组件的约定。
Ø描述机构的商业活动或设备的变量。
Ø工程或企业认为对清楚性和可读性很重要的任何其它元素。
2对象命名约定应该使用一致的前缀来命名对象,使人们容易识别对象的类型。
下面列出了 Visual Basic 支持的一些推荐使用的对象约定。
2.1推荐使用的控件前缀控件类型前缀例子3D Panel Pnl PnlGroupAnimated button Ani AniMailBoxCheck box Chk ChkReadOnly Combo box, drop-down list box Cbo CboEnglishCommand button cmd CmdExitCommon dialog dlg DlgFileOpen Communications com ComFaxctr CtrCurrent Control(当特定类型未知时,在过程中所使用的)Data control dat DatBiblioData-bound combo box dbcbo DbcboLanguage Data-bound grid dbgrd DbgrdQueryResult Data-bound list box dblst DblstJobType Directory list box dir DirSourceDrive list box drv DrvTargetFile list box fil FilSourceForm frm FrmEntryFrame fra FraLanguage Gauge gau GauStatusGraph gra GraRevenueGrid grd GrdPricesHorizontal scroll bar hsb HsbVolumeImage img ImgIconKey status key KeyCapsLabel lbl LblHelpMessage Line lin LinVerticalList box lst LstPolicyCodes MAPI message mpm MpmSentMessage MAPI session mps MpsSessionMCI mci MciVideoMDI child form mdi MdiNoteMenu mnu MnuFileOpenMS Flex grid msg MsgClientsMS Tab mst MstFirstOLE ole OleWorksheet Outline out OutOrgChart Pen BEdit bed BedFirstName Pen Hedit hed HedSignature Pen ink ink InkMapPicture pic PicVGAPicture clip clp ClpToolbar Report rpt rptQtr1Earnings Shape shp ShpCircleSpin spn SpnPagesText box txt TxtLastName Timer tmr TmrAlarm UpDown upd UpdDirection Vertical scroll bar vsb VsbRateSlider sld SldScale ImageList ils IlsAllIcons TreeView tre TreOrganization Toolbar tlb TlbActions TabStrip tab TabOptions StatusBar sta StaDateTime ListView lvw LvwHeadingsProgressBar prg PrgLoadFile RichTextBox rtf RtfReport2.2推荐使用的数据访问对象 (ADO、DAO) 的前缀用下列前缀来指示数据访问对象。
编码规则VB的语言元素(一)字符集程序由语句构成;语句由表达式、单词构成;表达式和单词由字符组成;程序语言中,字符、词汇、表达式、语句、过程、函数被称为“语法单位”。
语法的形成规则称为“语法规则”。
字符是构成程序设计语言的最小单位。
VB的字符集包括:数字,英文字母和特殊符号。
数字:0 - - - 9英文字母:26个英文字母的大小写a - - - z和A - - - Z特殊字符:! # $ % & @ 八'()* + ,-.八? < = > [ ] _ {} ~ : ;〃space注:在代码窗口输入程序时,除汉字外,其余符号不能以全角或中文方式输入,而只能以英文方式键入作为语言成分的字符。
例如:Print “x*y= ”;x*y(二)词汇集词汇符号是程序设计语言中具有独立意义的最基本结构。
词汇符号包括:运算符、界符、关键字、标识符、各类型常数。
1.运算符和界符算术运算符:+ - * / \ MOD八字符运算符:& +比较运算符:> >= < <= = <>逻辑运算符:NOT AND OR XOR EQV IMP其他界符:!#$% @( ),.'?[]_{ }丨〜:;〃space2.关键字又称保留字,是VB保留下来的作为程序中有固定含义的标识符,不能被重新定义,是语言的组成部分,往往表示系统提供的标准过程、函数、运算符、常量等。
在VB中,约定关键字的首个字母为大写。
VB中的关键字详见表3-18:表3-18 VB的关键字AsBinaryByRefByValDateElseEmptyErrorFalseForFriendGetInputIsLenLetLockMe MidNewNextNothingNullOnOptionOptionalParamArrayPrintPrivatePropertyPublicRe sumeSeekSetStaticStepStringThenTimeToTrueWithEvents3.标识符标识符是程序员为变量、常量、数据类型、过程、函数、类等定义的名字。
5、程序编码规范
变量命名约定
前台VB程序变量约定,变量名由前缀和中文名称组成,即:AB变量名,其中A 表示该变量的范围即:
后台Oracle存储过程,函数以及触发器也可能使用到变量,与VB程序约定一致,如:
⏹VB过程命名约定
由于VB的过程不返回任何值,因此在过程名前加动词Do,代表要做一件事,如:Private Sub Do设置窗口颜色(vl颜色值 As Long)
……
End Sub
⏹VB函数命名约定
由于VB的函数除了要处理一件事或做一个计算外,还要返回一个值,因此在函数名前加动词Get ,代表要得到一个值,如:
Private Sub Get得到拼音简码(vs中文字串 As String)
……
End Sub
⏹Oracle 存储过程约定
Oracle 存储过程通常要处理一件事,并且要通过一个参数返回一个结果,每个存储过程名前加入Do,如:
CREATE OR REPLACE PROCEDURE Do出库单审核
( vs操作类型 In nvarchar2,
vl单据序号 In numeric,
vl同步序号 In numeric,
vl操作员 In numeric,
ps处理成功 Out nvarchar2,
ps失败描述 Out nvarchar2
)
IS
Begin
……
ps处理成功:='是';
End Do出库单审核;。