Coding conventions

Object Naming Conventions

Object name has 2 parts: prefix and description.

The prefix that makes it easy to identify the type of object, the description mentions name of objects.

- Conventions of description part are:

+ In English.

+ Can contain many words, each word is contiguous to others (No hyphen).

+ No acronym except listed in table Acronyms (see 4. Acronym).

+ Capitalize the first letter of each word.

(Note: These conventions will be applied to all of name types mentioned after in this document)

- Prefix conventions for some of the objects supported by Visual Basic are listed below (Sorted by control name):

Cont r ol t y pe	P r efix	E x a m ple
3D Panel	Pnl	pnlGroup
ADO Data	Ado	adoBiblio
Animated button	Ani	aniMailBox
Check box	Chk	chkReadOnly
Combo box, drop-down listbox	Cbo	cboEnglish
Command button	Cmd	cmdExit
Common dialog	dlg	dlgFileOpen
Communications	com	comFax
Control (used withinprocedures when the specific type is unknown)	ctr	ctrCurrent
Data	dat	datBiblio

Data-bound combo box	dbcbo	dbcboLanguage
Data-bound grid	dbgrd	dbgrdQueryResult
Data-bound list box	dblst	dblstJobType
Data combo	dbc	dbcAuthor
Data grid	dgd	dgdTitles
Data list	dbl	dblPublisher
Data repeater	drp	drpLocation
Date picker	dtp	dtpPublished
Directory list box	dir	dirSource
Drive list box	drv	drvTarget
File list box	fil	filSource
Flat scroll bar	fsb	fsbMove
Form	frm	frmEntry
Frame	fra	fraLanguage
Gauge	gau	gauStatus
Graph	gra	graRevenue
Grid	grd	grdPrices
Hierarchical flexgrid	flex	flexOrders
Horizontal scroll bar	hsb	hsbVolume
Image	img	imgIcon
Image combo	imgcbo	imgcboProduct
ImageList	ils	ilsAllIcons
Label	lbl	lblHelpMessage
Lightweight check box	lwchk	lwchkArchive
Lightweight combo box	lwcbo	lwcboGerman
Lightweight command button	lwcmd	lwcmdRemove
Lightweight frame	lwfra	lwfraSaveOptions
Lightweight horizontal scrollbar	lwhsb	lwhsbVolume
Lightweight list box	lwlst	lwlstCostCenters
Lightweight option button	lwopt	lwoptIncomeLevel
Lightweight text box	lwtxt	lwoptStreet
Lightweight vertical scroll bar	lwvsb	lwvsbYear
Line	lin	linVertical
List box	lst	lstPolicyCodes
ListView	lvw	lvwHeadings
MAPI message	mpm	mpmSentMessage
MAPI session	mps	mpsSession
MCI	mci	mciVideo
Menu	mnu	mnuFileOpen
Month view	mvw	mvwPeriod
MS Chart	ch	chSalesbyRegion
MS Flex grid	mfg	mfgClients
MS Tab	mst	mstFirst
OLE container	ole	oleWorksheet
Option button	opt	optGender
Picture box	pic	picVGA
Picture clip	clp	clpToolbar
ProgressBar	prg	prgLoadFile
Remote Data	rd	rdTitles
RichTextBox	rtf	rtfReport
Shape	shp	shpCircle
Slider	sld	sldScale
Spin	spn	spnPages
StatusBar	sta	staDateTime
SysInfo	sys	sysMonitor
TabStrip	tab	tabOptions
Text box	txt	txtLastName
Timer	tmr	tmrAlarm
Toolbar	tlb	tlbActions
TreeView	tre	treOrganization
UpDown	upd	updDirection
Vertical scroll bar	vsb	vsbRate

Prefix conventions for menus

Menu control prefixes will be extended beyond the initial "mnu" label by adding an additional prefix for each level of nesting, with the final menu caption at the end of the name string. The following table lists some examples.

Menu caption sequence	Menu h a ndler n a me
File Open	mnuFileOpen
File Send Email	mnuFileSendEmail
File Send Fax	mnuFileSendFax
Format Character	mnuFormatCharacter
Help Contents	mnuHelpContents

Variable naming conventions

Variable name must describe data type, scope and identifier of a variable.

Variable data types

D ata type	P r e f i x	Ex a mple
Boolean	bln
Byte	byt
Currency	cur
Date (Time)	dtm
Double	dbl
Error	err
Integer	int
Long	lng
Object	obj
Single	sng
String	str
User-defined type	udt
Variant	vnt

Variable scope prefixes

Scope	P r efix	E x a m ple	N ote
Global	G	gstrUserName	This variable is global and string type
Module-level	M	mblnCalcInProgress	This variable is module and booleantype
Local toprocedure	None	dblVelocity	This variable is local and double type

Constants

The constant names will be UPPER_CASE with underscores (_) between words. For example:

Example	N ote
USER_LIST_MAX
NEW_LINE

Prefixes for ActiveX Data Objects(ADO)

Use the following prefixes to indicate ActiveX Data Objects.

A DO object	P r e f i x	Ex a mple
Command	Cm	cmTitles
Connection	Cn	cnTitles
Field	Fld	fldName
Field Collection	flds	fldsTitles
Parameter	prm	prmTitleName
Parameter Collection	prms	prmsNames
Recordset	Rs	rsTitles

Structured Coding Conventions

In addition to naming conventions, structured coding conventions, such as code commenting and consistent indenting, can greatly improve code readability.

Code Commenting Conventions

All procedures and functions should begin with a brief comment describing the functional characteristics of the procedure (what it does). Input, output patameters passed to a procedure should be described. Function return values and global variables that are changed by the procedure must also be described at the beginning of each procedure.

Section he a ding	C o mm e nt d e sc r iption
Purpose	What the procedure does (not how).
Inputs	Describe roles of input parameters
Outputs	Describe roles of output parameters
Returns	Explanation of the values returned by functions.
Author	Author of module

Remember the following points:

- Every important variable declaration should include an inline comment describing the use of the variable being declared.

- Variables, controls, and procedures should be named clearly enough that inline commenting is only needed for complex implementation details.

- At the start of the.bas module that contains the project's Visual Basic generic constant declarations, we should include an overview that describes the application, enumerating primary data objects, procedures, algorithms, dialogs, databases, and system dependencies. Sometimes a piece of pseudocode describing the algorithm can be helpful.

Formatting Your Code

Here are a few pointers:

- Standard, tab-based, nested blocks should be indented four spaces (as the Visual Basic default).

- The functional overview comment of a procedure should be indented one space. The highest level statements that follow the overview comment should

be indented one tab, with each nested block indented an additional tab. For

example:

'***************************************************** ' Purpose: Locates the first occurrence of a ' specified user in the UserList array. ‘ Inputs: ‘ strUserList(): the list of users to be searched. ‘ strTargetUser: the name of the user to search for. ' Returns: The index of the first occurrence of the ' rsTargetUser in the rasUserList array. ' If target user is not found, return -1. '***************************************************** Function FindUser (strUserList() As String, strTargetUser As _ String)As Integer Dim inti As Integer ' Loop counter. Dim blnFound As Integer ' Target found flag. intFindUser = -1 inti = 0 While inti <= Ubound(strUserList) and Not blnFound If strUserList(inti) = strTargetUser Then blnFound = True intFindUser = inti End If Wend End Function

Grouping Constants

Visual Basic generic constants will be grouped in a single module to separate them from application-specific declarations.

& and + Operators

Always use the & operator when linking strings and the + operator when working with numerical values. Using the +operator to concatenate may cause problems when operating on two variants. For example:

vntVar1 = "10.01" vntVar2 = 11 vntResult = vntVar1 + vntVar2 'vntResult = 21.01 vntResult = vntVar1 & vntVar2 'vntResult = 10.0111

Creating Strings for MsgBox, InputBox, and SQL Queries

When creating a long string, use the underscore line-continuation character to create multiple lines of code so that you can read or debug the string easily. This technique is particularly useful when displaying a message box (MsgBox) or input box (InputBox) or when creating an SQL string. For example:

Dim Msg As String Msg = "This is a paragraph that will be " _ & "in a message box. The text is" _ & " broken into several lines of code" _ & " in the source code, making it easier" _ & " for the programmer to read and debug." MsgBox Msg Dim QRY As String QRY = "SELECT *" _ & " FROM Titles" _ & " WHERE [Year Published] > 1988" TitlesQry.SQL = QRY

Other conventions

Error trapping in development progress must follow these rules:

- Cascading error trapping. That mean all called functions will return system error codes, and showing message box will be implemented at the most exterior function/procedure.

- All system message will be located in resource file.

- Showing message boxes are implemented by pass parameters to a showing message global function.

Items	Conversations	Note
Interface	In Vietnamese
Font name	MS Sans serif	Default
Font size	Default
Font color	Black	Default
Font style	Normal	Default
Distance between command buttons	100 Points
Command buttons alignment	Right
Label alignment	Left
All labels in a form must be collected in an array
All command buttons in a form must have same width
Caption of OK button	Chấp nhận
Caption of Cancel button	Thoát
Caption of Help button	Hướng dẫn
Caption of Add button	Thêm mới
Caption of Delete button	Xoá
Caption of Edit button	Sửa
Caption of Close button	Đóng
Caption of Save button	Ghi
Order of buttons in from (Left to right):
Thªm míi-Ghi-Söa-Xo¸-ChÊp nhËn-Tho¸t-H- íng dÉn
Default button	Chấp nhận
Cancel button	Đóng

- Error code contains 3 number.

- Versioning all modules: form module, code module...

- Display solution: 800x600 pixels

- Font size setting: Large font

- All of file name (*.vbp, *.frm, *.bas...) must less than 3 characters.

- Error code = 0 is OK.

- Error code < 0 is error.

- Error code >0 is warning.

- Function names should begin with a verb, such as InitNameArray or CloseDialog.

Form design standard

Common conventions in form design

Sample:

Form controls appearance conventions

C ont r ol	P r operty	V a lue	N ote
Check box
	All colors	Default
Combo box, drop-down list box
	Height	315
	All colors	Default
Command button
	Height	375 Points
	Back color	Button face	VB Default
Form
	Border style	Fixed length
	Back color	Button face	VB Default
	Startup position	CenterScreen
Label
	Back color	Button face	VB Default
Vervical scroll bar
	Width	260 Points
Horizontal scroll bar
	Height	260 Points
Option button
	Height	255 Points
Text box
	Height	285 Points
	All color	Default

Report design standard (for Crystal Report)

Common conventions in report design

Items	Conventions	Note
Above of each total row must be a line, calledGrouping line
Report boder	Only title row isbordered
Colour of all objects in report (line,character...)	Black

Report objects appearance conventions

Object	Property	Setting	Note
Report title
	Font name	.VnArialH
	Font style	Bold
	Justify	Paper center
	Space betweenreport title and collumn heading	50 Points	Should bereviewed
Colunmheading
	Font name	.VnArialNarrow
	Font style	Bold
	Font size	10
	Justify	Column left
	Before rowspacing	6 Points
	After row spacing	6 Points
Report body(data)
	Font name	.VnArialNarrow
	Font style	Bold
	Font size	9
	Justify	Depend on column data type(Number: right, string: right, date: center)
	Row spacing	0
Total row
	Font name	.VnArialNarrow
	Font style	Bold
	Font size	9
	Justify	Right
	Position	Under data block thatsummarized
Grouping line
	Width	1 Point
Report boder
	Width	1 Point
	Boder columntitle only
Page number
	Font name	.VnArial
	Font size	9
	Font style	Normal
	Position	Right, bottom of page (Reportfooter)
	Style	Page/Total page
Left sub title
	Font name	.VnArial
	Font size	10
	Font style	Normal
	Justify	Margin left
Right sub title
	Font name	.VnArial
	Font size	10
	Font style	Normal

Sample:

Left subtitle Report title Right subtitle

Database design standards

All of object names (include: table names, view names, field names...) in database must follow these conventions:

- In English.

- Can containts one or more words and no underscore between these words.

- No acronym except listed in table Acronyms bellow.

- The first letter of each word must be capitalized.

Soạn thảo Code

Ngoài khả năng soạn thảo văn bản để viết chương trình, cửa sổ Code còn hỗ trợ một số chức năng khác như:

Đánh dấu (marks)

Dùng đánh dấu các dòng chương trình trong cửa sổ Code để dễ dàng xem lại về sau. Để bật tắt khả năng này, cũng như tìm kiếm dấu hiện hành, chọn Bookmarks từ menu Edit, hoặc chọn từ thanh công cụ Edit.

Dùng phím trong cửa sổ Code

Chức n ă ng	Ph í m tắt
Xem cửa sổ Code	F7
Xem cửa sổ Object Browser	F2
Tìm kiếm	CTRL + F
Thay thế	CTRL + H
Tìm tiếp	SHIFT + F4
Tìm ngược	SHIFT + F3
Chuyển đến thủ tục kế tiếp	CTRL + DOWN ARROW
Chuyển đến thủ tục trước đó	CTRL + UP ARROW
Xem định nghĩa	SHIFT + F2
Cuộn xuống 1 màn hình	CTRL + PAGE DOWN
Cuộn lên một màn hình	CTRL + PAGE UP
Nhảy về vị trí trước đó	CTRL + SHIFT + F2
Trở về đầu của mô-đun	CTRL + HOME
Đến cuối mô-đun	CTRL + END
Chức n ă ng	Ph í m tắt
Dời con trỏ sang phải 1 từ	CTRL + RIGHT ARROW
Dời con trỏ sang trái 1 từ	CTRL + LEFT ARROW
Dời con trỏ về cuối dòng	END
Dời con trỏ về đầu dòng	HOME
Lấy lại hành động trước đó	CTRL + Z
Xoá dòng hiện hành	CTRL + Y
Xoá 1 từ	CTRL + DELETE
Canh trái	TAB
Bỏ hành động canh trái trước đó	SHIFT + TAB
Xoá tất cả các điểm dừng (break-points)	SHIFT + SHIFT + F9
Xem menu cảm ngữ cảnh	SHIFT + F10

Một số chức năng tự động

Khai báo biến

Để khai báo biến ta dùng lệnh Dim: Dim <Tên biến > [As<kiểu dữ liệu>]

Biến khai báo trong thủ tục chỉ tồn tại khi thủ tục thi hành. Nó sẽ biến mất khi thủ tục chấm dứt. Giá trị của biến trong thủ tục là cục bộ đối với thủ tục đó, nghĩa là ta không thể truy nhập biến từ bên ngoài thủ tục. Nhờ đó, ta có thể dùng trùng tên biến cục bộ trong những thủ tục khác nha.

Kiểu dữ liệu trong khai báo Dim có thể là những kiểu cơ bản như Integer, String hoặc Currency. Ta cũng có thể dùng đối tượng của VB (như Object, Form1, TextBox) hoặc của các ứng dụng khác.

Khai báo biến trong phần Declarations của một mô-đun nghĩa là biến đó tông tại và có tầm hoạt động trong mô-đun đó.

Khai báo biến với từ khoá Public nghĩa là biến đó tồn tại và có tầm hoạt động của toàn ứng dụng .

Khai báo biến cục bộ với từ khoá Static nghĩa là mặc dầu biến đó biến mất khi thủ tục chấm dứt, nhưng giá trị của nó vẫn được giữ lại để tiếp tục hoạt động khi thủ tục được gọi trong lần sau.

Khai báo ngầm

Nghĩa là ta không cần khai báo tường minh trước khi sử dụng biến.

Function SafeSqr(num) TempVal = Abs(num) SafeSqr = Sqr(TempVal) End Function

Mặc dù cách này có vẻ thuận tiện nhưng có thể gây lỗi nếu ta gõ nhầm tên biến.

unction SafeSqr(num) TempVal = Abs(num) SafeSqr = Sqr(TemVal) End Function

Hàm này trả về zero. Khi VB gặp tên mới, nó tạo ra một biến khác với tên đó.

Khai báo tường minh

Để tránh những rắc rối trên, ta nên quy định VB phải báo lỗi khi gặp một tên biến không khai báo. Ta đặt dòng lệnh :

Option Explicit

Trong phần Declarations của mô-đun. Một cách khác, từ menu Tools, chọn

Options, chọn tab Editor và đánh dấu vào tuỳ chọn Require Variable Declaration. VB tự động chèn dòng lệnh Option Explicit vào một mô-đun mới, nhưng không phải là những mô-đun đã được tạo. Do đó, đối với các mô-đun này, ta phải thêm dòng lệnh bằng tay.

Option Explicit chỉ hoạt động trên từng mô-đun. Vì vậy, ta phải thêm dòng này vào mỗi mô-đun của biểu mẫu, mô-đun chuẩn, hay mô-đun lớp.

Khai báo biến Static

Để khai báo tát cả các biến cục bộ trong một thủ tục là Static, ta đặt từ khoá Static vào tên thủ tục:

Static Function RunningTotal(num)

VB sẽ hiểu rằng tất cả các biến khai báo trong thủ tục này đều là Static, dù cho chúng được khai báo là Private, là Dim hoặc thậm chí khai báo ngầm.

Từ khoá Static có thể đặt ở đầu thủ tục Sub hoặc Function, kể cả thủ tục xử lý sự kiện hoặc những hàm Private.

Hằng

Dùng để chứa những dữ liệu tạm thời nhưng không thay đổi trong suốt thời gian chương trình hoạt động. Sử dụng hằng số làm chương trình sáng sủa và dễ đọc nhờ những tên gợi nhớ thay vì các con số. VB cung cấp một số hằng định nghĩa sẵn, nhưng ta có thể tự tạo hằng.

Ta có thể dùng cửa sổ Object Browser để xem danh sách các ứng dụng hằng có sẵn của VB và VBA( Visual basic for Application). Các ứng dụng khác cung cấp những thư viện đối tượng, như Microsoft Exel, Microsoft Project, hoặc các thư viện của điều khiển ActiveX cũng có hằng định nghĩa sẵn.

Trong trương hợp trùng tên hằng trong những thư viện khác nhau, ta có thể dung cách chỉ rõ tham chiếu hằng:

[<Libname>][<tên mô-đun>]<tên hằng>

Libname là tên lớp, tên điều khiển hoặc tên thư viện.

Cấu trúc chọn

So sánh mặc định trong Visual basic mặc định là so sánh có phân biệt cỡ chữ. Nếu muốn tắt chế độ này, ta thêm dòng khai báo sau vào chương tình

Option Copare Text

Nếu muốn trả về trạng thái ban đầu, có 2 cách: Đưa dòng khai báo:

Option Compare Binary

Chỉ cần xoá dòng khai báo “Option Compare Text” Các biểu thức so sánh

K ý hiệu	Ý nghĩa
=	Bằng
<>	Khác
>	Lớn hơn
<	Nhỏ hơn
>=	Lớn hơn hoặc bằng
<=	Nhỏ hơn hoặc bằng

Cấu trúc lặp

Làm việc với cấu trúc

Ta có thể lồng các cấu trúc với nhau ví dụ có thể lồng nhiều vòng For Nẽex với nhau. Để thoát khỏi cấu trúc ta dùng lệnh Exit, Exit for cho phép thoát khỏi vòng For, Exit do cho phép thoát khỏi Do loop.

Gỡ rối chương trình

Không một chương tình nào là không có lỗi. Tuy nhiên, giảm khả năng lỗi đến mức tối thiểu là có thể làm được. Để có chương trình tốt, ta cần có thiết kế chặt chẽ. Sau đó, chương trình phải được viết sao cho có ít sinh lỗi và nếu có thì dễ tìm.

Một số giải pháp giảm lỗi

• Thiết kế cẩn thận, ghi ra các vấn đề quan trọng và cách giải quyết cho từng phần. Ghi ra từng thủ tục và mục đích của nó.
• Chú thích rõ ràng trong chương trình
• Đối tượng có tham chiếu tường minh thay vì kiểu chung chung như Object, Control
• Tuân thủ Coding convention
• Một tỏng những nguyên nhân gây lỗi là gõ sai tên biến hoặc nhầm lẫn điều khiển. Dùng Option Explicit để tránh trường hợp này.

Truyền giá trị khi gọi thủ tục

Là một trong những cách giảm thiểu khả năng lỗi. Tuy nhiên, trở ngại duy nhất của nó là tiêu tốn nhiêềuvùng nhớ hơn truyền địa chỉ, làm chương tình chạy chậm hơn.

Đối tượng Err

Là đối tượng do Visual basic cung cấp sẵn. Nó có vô số thuộc tính. Sau đây là những thuộc tính thông dụng:

T h uộc tí n h	Giải thích
Number	Giá trị mặc định, số hiệu lỗi
Description	Mô tả lỗi
Source	Tên đối tượng gây ra lỗi

Gỡ rối

Có thể tạm dừng chương trình bằng cách chọn Break từ menu Run hoặc nhấn trên thanh công cụ, hoặc nhấn trên tổ hợp phím Ctrl-Break. Ta cũng có thể đặt dòng lệnh Stop trong chương trình nhưng sẽ có cách khác tốt hơn.

Cửa sổ Immediate

Cửa sổ này cho phép ta xem các giá trị của các biến trong form khi ta chaỵ gỡ rối

Cửa sổ Watch

Hiển thị các giá trị của một biến, thuộc tính hay biểu thức bất kỳ. Thậm chí có thể buộc chương trình tạm ngưng sau một số lần lặp.

Đi qua từng dòng chương trình

Thanh Debug

Thứ tự nút bấm từ trái sang phải như sau:

- Start: thi hành chương trình

- Break: tạm dừng chương trình

- End: Kết thúc chương trình

- BreakPoint: Điểm đánh dấu dòng lệnh để tạm dừng chương trình. Nút này được sử dụng để bật tắt chế độ breakpoint. Khi có lỗi xảy ra và ta chưa khoanh được khu vực nghi ngờ, thì Breakpoint là giải pháp tốt nhất để cô lập vùng chương trình bị lỗi.

- Step Into: Nếu dòng lệnh hiện hành đang gọi một thủ tục, nhấn F8 sẽ nhảy vào bên trong thủ tục.

- Step Over: Nếu dòng lệnh hiện hành đang gọi một thủ tục, nhấn Shipt- F8 sẽ chạy qua thủ tục.

- Step Out: Nếu điểm dừng đang ở trong một thủ tục, nhấn Ctrl-Shift-F8

sẽ chạy hết thủ tục và dừng ở dòng kế tiếp sau lệnh gọi thủ tục

- ......

Bẫy lỗi