Du bist hier: Startseite > Wissenswertes > Gut gewählte Namen für alle Elemente

Gut gewählte Namen für alle Elemente

Den richtigen Ausdruck finden ...

In den 80. Jahren war es noch so, dass die Rechner kaum Speicherplatz zur Verfügung hatten und deswegen sehr eingeschränkt waren in der Namensgebung. Es war völlig üblich, dass man Begriffe wie "dskMgr" (DiskManager) in den Systemen gefunden hat. Heutzutage gibt es solche Speicherprobleme in der Namensvergabe nicht mehr. Viel wichtiger ist, dass man einen eindeutigen Namen für das Element findet und direkt weiss was damit überhaubt gemeint ist.

Ein Beispiel:
Es muss ein Name her für ein Controller der die Bildschirm Auflösung speichert, da wird auch nicht lange gefackelt und das Teil heisst auf einmal "BildschirmeinstellungenJuni". Hört sich zuerst alles logisch an. Jetzt kommt 3 Monate später ein neuer ins Team und Mister BildschirmeinstellungenJuni hat ne Krippe und ist nicht da. Das Problem ist jetzt, dass was damals gemacht worden ist, ist mit dem Namen nicht direkt Identifizierbar. Mit einem Namen wie "monitor1DisplaySettingsResolution" wäre das nicht passiert.

Wenn du also einen Namen vergibst, dann stell dir immer die Frage, ob du selbst nur Anhand des Namens wüsstest, was es ist und wo du es findest. Die Schreibweise sollte CamelCase sein. Das bedeutet, alle Wörter werden direkt aneinander gehangen wobei nur der erste Buchstabe von jedem Wort Groß geschrieben wird. Der erste Buchstabe vom Ganzen wird aber trotzdem klein geschrieben. "dasHierIstToatalCamelCaseValide" Diese Schreibweise kann man gut lesen und was noch viel wichtiger ist, mit sowas kann man z.B. eine Navigation aufbauen. Ausserdem solltest du immer in Englisch schreiben.

Schreibweise

Du solltest dir auch direkt angewöhnen, bei sämtlichen Namen für deine Elemente denn Datentyp mit zu notieren. Somit hast du beim Programmieren direkt denn Überblick um welchen Datentyp es sich bei dem Element handelt.

Bei einem Namen wie "pIResolution" weiss der Programmierer direkt, dass es sich hierbei um einen Pointer handelt der auf eine Integer Variable zeigt.

Wenn nicht anderes angegeben, dann nutze immer die CamelCase Schreibweise!

Für Zusatz Beispiel
C++ Dateien: Alles klein meinedatei.cpp
C++ Headerdateien: Alles klein meineheaderdatei.h
#define und Macro Namen: Groß schreiben MEINEHEADERDATEI_H
Variable: Mit Datentyp iMeineVariable (int)
Statische Variable: Mit _ und Datentyp _bMeineVariable (bool)
Vector: Mit Datentyp vIMeinVector (int)
Klassennamen: meineKlasse
Funktions und Methoden Namen: meineFunktion
Namespace: meinNamensraum
Pointer: pIMeinPointerName (int)
Referenz: rIMeinReferenzName (int)

In der Tabelle wurde jetzt nur der Datentyp int für Variablen gezeigt, dass gilt aber natürlich für alle! Mit dem Zusatz Datentyp für Variablen ist der erste Buchstabe des Datentyp´s gemeint.