Při tvorbě sdílených kódů nebo při společné tvorbě projektu ve vývojovém týmu, je vždy nejtěžší psát kód takovým způsobem, aby byl pro jiné programátory srozumitelný. Nejtěžší je snad pochopit, co která proměnná v kódu znamená a jakou hodnotu nese. Pro zjednodušení čtení kódu nezúčastněnou osobou je dobré dodržovat konvence při psaní kódu. Následující odstavce Vám nabídnou jednu z možných konvencí. Je na Vás jestli ji přijmete nebo si vytvoříte vlastní.
Při používání proměnných je výhodné používat následující formát pro jméno proměnné:
prefixVyznamoveJmeno
Význam jednotlivých částí pojmenování:
Tabulka1 - určení prefixů pro různé datové typy
| Datový typ | Prefix | Příklad |
|---|---|---|
|
Boolean
|
bln
|
blnItemProc
|
|
Byte
|
byt
|
bytItemAlloc
|
|
Currency
|
cur
|
curEuroTax
|
|
Date
|
dat
|
datProjComp
|
|
Double
|
dbl
|
dblPntInsert
|
|
Integer
|
int
|
intNumCount
|
|
Long
|
lng
|
lngHwndGet
|
|
Object
|
obj
|
objAcadApp
|
|
Single
|
sng
|
sngValCount
|
|
String
|
str
|
strAttrReplc
|
|
User-defined
type
|
udt
|
udtEmplRec
|
|
Variant
|
var
|
varPntGet
|
Nejjednodušší a snad i nejsnáze zapamatovatelná je konvence zavedená firmou Microsoft - před jméno proměnné uvést malým písmem dvojpísmenný prefix určující aplikaci.
Příklad pro objekt Aplikace Excel:
Dim xlApp As Excel.Application
Příklad pro objekt Aplikace AutoCAD:
Dim acNewDoc As AcadDocument
Pokud sloučíte obě uvedené konvence (z tabulky1 a právě uvedenou) a použijete generickou definici objektu, dostanete následující jméno proměnné:
Příklad pro objekt Aplikace Excel:
Dim ObjXLApp As Object
Příklad pro objekt Aplikace AutoCAD:
Dim ObjAcadApp As Object
Z příkladu je patrné, že byly definovány proměnné typu objekt - jednou aplikace Excel a jednou aplikace AutoCAD.
V programovém kódu je samozřejmě důležité označovat i rozsah platnosti proměnné. Pro označení platnosti proměnné použijeme následující prefix:
Tabulka2 - určení prefixů pro různé rozsahy platnosti
| Rozsah | Prefix |
Příklad proměnné |
|
Modul
|
m
|
mstCurrPath
|
|
Globální
|
g
|
gstrCurrPath
|
Pro označení proměnné pole použijeme prefix a:
Dim astrPole Text() As String
Pro proměnné AutoCADu použijeme stejné konvence jako jsme zavedli pro proměnnou objekt aplikace. Příklady pojmenování některých objektů AutoCADu:
Tabulka3 - určení prefixů pro různé typy objektů
|
Object
|
Příklad pojmenování
|
|---|---|
|
Application
|
acApp
|
|
Block Reference
|
acBlkRefResult
|
|
Block
|
acBlkDefParts
|
|
Line
|
acLineBoundry
|
|
Polyline
|
acPlineWaterSys
|
|
New Drawing
|
acDocNew
|
|
ModelSpace
|
acMspaceCol
|
|
PaperSpace
|
acPspaceCol
|
|
Point
|
acPntBlkIns
|
Ostatní objekty AutoCADu jsou pojmenovány obdobným způsobem.
