Reddick-Namenskonvention
aus Wikipedia, der freien Enzyklopädie
Inhaltsverzeichnis |
[Bearbeiten] Erklärung
Die Reddick Namenskonvention wurde 1992 das erstmal in vielen Büchern und Fachmagazinen erwähnt und ist für viele Programmierer eine Anleitung für die Namensgebung von Variablen. Und auch heute spielt sie selbst in .NET noch eine wichtige Rolle. Durch die Konvention ist es sehr leicht für andere Programmierer die Bedeutung der Variable schon beim Lesen zu verstehen. Schlechte Beispiele sind i1, i2, i3, i4, i5, ...
Für die Namensgebung von Variablen gibt es 4 Bausteine
[Präfix] Typkürzel [Basisname[Suffix]]
Erklärung
| Tag | Bedeutung |
|---|---|
| Präfix | ergänzt das Typkürzel um zusätzliche Infos, es wird in Kleinbuchstaben angegeben. |
| 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 |
| BasisName | ist der sonst übliche Variablenname wie "ErrechneteZahl" - Wobei hier das PascalCaseing zur Anwendung kommt, wo man die Anfangsbuchstaben jedes Worts groß schreibt. |
| Suffix | beinhaltet nochmal zusätzliche Informationen zu der Variable
z.B. Min, Max, Cnt(Count), Lim, First, Last |
[Bearbeiten] Auswahl möglicher Typkürzel
| Tag | Object Type |
|---|---|
| bool {f, bln} | Boolean |
| byte {byt} | Byte |
| cur | Currency |
| date {dtm} | Date |
| dec | Decimal |
| dbl | Double |
| int | Integer |
| lng | Long |
| obj | Object |
| sng | Single |
| str | String |
| stf | String (fixed length) |
| var | Variant |
[Bearbeiten] Präfixe
Dem Präfix kann immer noch ein Indizie davor und danach angefügt werden:
| Präfix | Objekttype |
|---|---|
| (keinen) | Lokale Variable, Lebenszeit auf Prozedurebene |
| 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 |
| c | Zähler (Count) eines Objekttyps |
| h | Zeiger (Handle) auf ein Windows-Objekt |
| r | Parameter, der „By References“ übergeben wurde |
z.B.
- gintKundenID - global Integer "KundenID"
- mintBenutzerName - privat (modular) Integer "BenutzerName"
[Bearbeiten] Beispiele
Einfache:
- boolEingabe - Boolean
- strName
- objWikiPedia
Mit Tag:
- strfName, strfTelefon, strfAnschrift, strfPlzOrt für ein Formular z.B.
Mit Suffix
- strName1, strName2, ...
- strInputCount (Count ist hier das Suffix)
[Bearbeiten] Sonstiges
Für VBA, Access etc. gibt es natürlich noch weitere Prefixe für jedes Element.
