MS-Office-Forum

Zurück   MS-Office-Forum > Microsoft Access & Datenbanken > Microsoft Access - MOF-FAQ > MOF-FAQ - Verschiedenes
Registrieren Forum Hilfe Alle Foren als gelesen markieren

Banner und Co.

Antworten
Ads
Themen-Optionen Ansicht
Alt 10.10.2003, 23:45   #1
Günther Kramer
MS-Office-Forum Team MS-Office-Forum Team
Standard Reddick-VBA-Namenskonvention

Dieser Beitrag wurde von Heiko (Aquarii) zusammengestellt.

Reddick-VBA-Namenskonvention

1.Einleitung

Die Absicht der Reddick-VBA-(RVBA) Namenskonvention besteht darin, eine Richtlinie zu schaffen, um Objekte in Visual Basic for Application (VBA) zu benennen. So enthält der Name eines Objektes Informationen über die Bedeutung des Objektes.

Die Syntax eines Objektnames nach der RVBA stellt sich wie folgt dar:

[Präfix] Typkürzel [Basisname[Suffix]]

Hierbei bezeichnen die eckigen Klammern die optionalen Teile des Objektnamens. Die einzelnen Komponenten der Syntax im einzelnen:

Das Präfix ergänzt das Typkürzel um zusätzliche Infos, es wird in Kleinbuchstaben angegeben. (siehe Punkt 4. Präfixe)

Das Typkürzel, im englischen kurz mit „Tag“ bezeichnet besteht aus einer kurzen Folge von Buchstaben, die den Typ des Objektes anzeigen. Für den Typkürzel werden Kleinbuchstaben verwendet (siehe Punkt 2.1 Typkürzel).

Der Basisname besteht aus einem oder mehreren Wörtern, die beschreiben, was das Objekt repräsentiert. Der erste Buchstabe jedes Wortes wird großgeschrieben.

Das Suffix bietet zusätzliche Informationen zur Bedeutung des Basisnamens. Der erste Buchstabe jedes Wortes wird großgeschrieben (siehe Punkt 5. Suffixe).

Beachtenswert ist, dass der einzige Teil eines Objektnamens, der wirklich benötigt wird aus dem Typkürzel besteht. Dies erscheint unlogisch, da der Basisname wichtiger erscheint. Aber: bei einer Prozedur, die innerhalb eines beliebigen Formulars arbeitet, ist es wichtig, dass diese Routine innerhalb des Formulars funktioniert und nicht was dieses Formular repräsentiert. Da diese Routine innerhalb verschiedenster Arten von Formularen arbeiten könnte, benötigt man nicht unbedingt den Basisnamen.

Sobald aber mehr als ein Objekt eines bestimmten Typs in einer Routine verwendet werden, muss für alle - außer einem - der Basisname verwendet werden, um eine Unterscheidung treffen zu können.

Da aber der Basisname Informationen zu der Variablen enthält, sollte deren Benennung in aller Regel den Basisnamen enthalten.

Im folgenden sind Ausschnitte aus der RVBA dargestellt:

2. Typkürzel

2.1 Typkürzel für Variablen

Typkürzel

Variablentyp

bool oder bln

Boolean

byte oder byt

Byte

cur

Currency

date

Date

dec

Decimal

dbl

Double

int

Integer

lng

Long

obj

Object

sng

Single

str

String

stf

String (feste Länge)

var

Variant

Beispiel:

intValue, lngCount, varWert, strEingabeBenutzer

2.2 Typkürzel für Auflistungen

Der Typkürzel einer Auflistung wird definiert, indem dem Datentyp der Auflistung ein „s“ angehängt wird.

Eine Auflistung des Datentyps „Long“ beispielsweise erhält das Typkürzel „lngs“. Entsprechend heißt das Typkürzel für eine Auflistung von Formularen „frms“.

Sollen verschiedene Datentypen in einer Auflistung verwendet werden, benutzt man das Typkürzel „objs“.

Beispiel:

lngsZahlen

frmsKundenAdressen

objsDiverses

2.3. Typkürzel für Konstanten

Konstanten haben in VBA immer einen Datentyp. Der Datentyp sollte immer explizit definiert werden, da sonst VBA den Datentyp festlegt.

Konstanten, die im Abschnitt der allgemeinen Deklaration stehen, sollten das Schlüsselwort Private oder Public enthaltenund mit dem Präfix (siehe Punkt 4. Präfixe) „m“ oder „g“ versehen werden. Die Konstante wird durch den an das Typkürzel gehängten Buchstaben “c“ gekennzeichnet:

Beispiel:

Private Const mdblcPi as Double = 3.1415

Obwohl diese Methode empfohlen wird, kann alternativ das Typkürzel con verwendet werden

Beispiel:

Private ConPi as Double = 3.1415

3. Prozeduren erstellen

VBA-Prozeduren erfordern Namen für verschiedene Objekte: die Prozeduren selbst, Parameter und Sprungmarken.

3.1. Prozedurnamen erstellen

Ereignisprozeduren werden direkt von VBA benannt, diese Namen sollten nicht verändert werden.

Bei benutzerdefinierten Prozeduren sollte der erste Buchstabe eines jeden Wortes großgeschrieben werden.

Beispiel:

cmdOK_Click

KundenNameAuslesen

DatenUebertragungBeginnen

Bei der Deklaration von Prozeduren sollte immer der Gültigkeitsbereich durch Public oder Privat angegeben werden:

Beispiel:

Public Function KundenNameAuslesen () as string

Private Sub DatenUebertragungBeginnen ()

3.2 Parameter benennen

Parameter sollten immer mit dem Zusatz ByVal oder ByRef verwandt werden, auch wenn ByRef optional ist.

Parameter für Prozeduren werden genauso benannt wie Variablen (siehe 2.1) desselben Typs, außer das Argumente, die „by Reference“ übergeben werden, den Zusatz „r“ erhalten.

Beispiel:

Public Sub Test (ByVal intInput as Integer, ByRef rlngOutput as long)

3.3 Sprungmarken benennen

Auch hier gilt, das der erste Buchstabe eines Wortes großgeschrieben wird:

Beispiel:

ErrorHandler

ExitProcedure

4. Präfixe

Ein Präfix soll einen Objektnamen so verändern, dass mehr Informationen über das Objekt zur Verfügung stehen.

4.1 Präfixe für Datenfelder (Arrays) von Objekten

Für Datenfelder des Typs Objekt wird die Vorsilbe „a“ verwendet:

Beispiel:

aintSchriftGroesse

astrName

4.2. Präfixe für Indizes

Ein Index in einem Datenfeld sollte mit der Vorsilbe „i“. Konsequenterweise sollte als Datentyp Long verwendet werden.

Beispiel:

iaint SchriftGroesse

4.3. Präfixe für Gültigkeitsbereiche und Lebensdauern

Für jede Variable gibt es in VBA drei Gültigkeitsebenen: Public, Private und Local. Eine Variable hat zusätzlich eine Lebensdauer der aktuellen Prozedur oder der Länge des Programms.

Folgende Präfixe gelten, um auf die Gültigkeitsebene und Lebensdauer hinzuweisen:

Präfix

Objekttyp

(keinen)

Lokale Variable, Lebenszeit auf Prozedurebene, wird mit „dim“ deklariert

s

Lokale (statische) Variable, Lebenszeit auf Programmebene, wird mit „Static“ deklariert

m

Private (modulare) Variable, Lebenszeit auf Programmebene, wird mit „Private“ deklariert

g

Public (globale) Variabel, Lebensdauer auf Programmebene, wird mit „Public“ deklariert

4.4 Andere Präfixe

Hier werden weitere Präfixe aufgeführt:

Präfix

Objekttyp

c

Zähler (Count) eines Objekttyps

h

Zeiger (Handle) auf ein Windows-Objekt

r

Parameter, der „By References“ übergeben wurde

Beispiel:

castrArray

hWndForm

5. Suffixe

Suffixe verändern den Basisnamen eines Objektes und werden für weitere Informationen über eine Variable verwendet.

Hier einige allgemeine VBA-Suffixe:

Suffix

Objekttyp

Min

Das absolut erste Feld eines Elementes oder Feldes

First

Das erste Element, das in einem Feld oder einer Liste während der aktuellen Operation verwendet wird.

Last

Das letzte Element, das in einem Feld oder einer Liste während der aktuellen Operation verwendet wird.

Max

Das absolut letzte Feld eines Elementes oder Feldes

Cnt

Wird mit Datenbankobjekten verwendet, um anzuzeigen, dass es sich um einen Zähler handelt. Zähler werden vom System automatisch hochgezählt, sie sind Zahlen vom Typ Long oder ReplikationsID.

Beispiel:

iastrNamenMin

lngKundenIDCnt

iaintSchriftGroesseFirst

6. Dateinamen

Für Dateinamen wird kein Typkürzel verwendet, da die Dateierweiterung den Objekttyp bereits angibt:

Beispiel:

Test.frm________ ___________ (frmTest Formular)

Globals.bas ___________ (globals Modul)

7. Erweiterungen für Komponenten

7.1 Access 2000, Version 9.0 Objekte

Typkürzel

Objekttyp (deutsch)

Objekttyp (englisch)

app

Applikation

Application

chk

Kontrollkästchen

CheckBox

cbo

Kombinationsfeld

ComboBox

cmd

Befehlsschaltfläche

CommandButton

ctl

Steuerelement

Control

ocx

Zusatzsteuerelement

CustomControl

dcm

DoCmd

DoCmd

frm

Formular

Form

hyp

Hyperlink

Hyperlink

img

Bild

Image

lbl

Bezeichnungsfeld

Label

lin

Linie

Line

lst

Listenfeld

ListBox

bas

Modul

Module

ole

Ole-Objekt

ObjectFrame

opt

Optionsfeld

OptionButton

fra

Optionsgruppe

OptionGroup (Frame)

brk

Seitenumbruch

PageBreak

pal

Farbpalette

PalletteButton

prps

Eigenschaften

Properties

ref

Referenz

Reference

rpt

Bericht

Report

scr

Bildschirm

Screen

sfr

Unterformular

SubForm

tab

Registersteuerelement

TabControl

txt

Textfeld

TextBox

tgl

Umschaltfläche

ToggleButton

     
     
     

Beispiele:

txtName

cmdOK

Günther Kramer ist offline  
verlinken auf Del.icio.us Diese Seite zu Mister Wong hinzufügen
Antworten Auf Beitrag antworten
Ads
Antworten


Aktive Benutzer in diesem Thema: 1 (Registrierte Benutzer: 0, Besucher: 1)
 
Themen-Optionen
Ansicht

Forumregeln
Es ist Ihnen nicht erlaubt, neue Themen zu verfassen.
Es ist Ihnen nicht erlaubt, auf Beiträge zu antworten.
Es ist Ihnen nicht erlaubt, Anhänge anzufügen.
Es ist Ihnen nicht erlaubt, Ihre Beiträge zu bearbeiten.

vB Code ist An.
Smileys sind An.
[IMG] Code ist An.
HTML-Code ist An.
Gehe zu


Alle Zeitangaben in WEZ +1. Es ist jetzt 14:16 Uhr.



Powered by: vBulletin Version 3.6.2 (Deutsch)
Copyright ©2000 - 2019, Jelsoft Enterprises Ltd.

Copyright ©2000-2018 MS-Office-Forum. Alle Rechte vorbehalten.
Copyright ©Design: Manuela Kulpa ©Rechte: Günter Kramer
Eine Verwendung der Inhalte in anderen Publikationen, auch auszugsweise,
ist ohne ausdrückliche Zustimmung der Autoren nicht gestattet.