Projektgruppe Visual Analytics - Medieninformatik und Multimedia ...

206 Kapitel 12 Qualitätssicherung
Konstanten werden komplett groß geschrieben. Unterstriche zur Trennung von
Wörtern werden dabei nicht verwendet. Die Namen folgen dem Prinzip Adjektiv
+ Nomen + Qualifizierer.
Methoden sollten nach dem Namensprinzip Verb + Adjektiv + Nomen + Qualifizierer
gewählt werden. Die Parameter einer Methode sind, wenn möglich,
in Gruppen zusammenzufassen, wobei für jede Gruppe eine eigene Codezeile
verwendet wird. Pro Methode wird nur ein return-Statement verwendet.
Event Handler reagieren auf Events. Diese Events werden mit einem Unterstrich an den
Objektnamen angehängt. Somit ergibt sich die Regel ObjectName_EventName
für EventHandler, zum Beispiel HelpButton_Click(object sender, EventArgs
e).
Interfaces bekommen ein vorangestelltes I, gefolgt von einem Namen, der die Eigenschaft,
die dieses Interface repräsentiert, beschreibt. Der erste Buchstabe dieser
Eigenschaft wird wiederum groß geschrieben, also zum Beispiel IComponent.
Klassen und Strukturen sollten, wenn möglich, mit Hilfe der #region-Befehle in
Regionen unterteilt werden. Alle öffentlichen Methoden, außer eindeutige Getterund
Setter- Methoden, werden mit Hilfe der Kommentierungsfunkton /// dokumentiert.
Die Namen der Klassen folgen dem Prinzip Nomen + Qualifizierer,
zum Beispiel CustomerForm. Klassen und Strukturen beginnen mit einem Großbuchstaben.
Ebenso werden komplexere nicht-öffentliche Methoden kommentiert.
Namespaces repräsentieren die logische Struktur von Subsystemen. Im Allgemeinen
sollte die Regel CompanyName.ProjectOrDomainName.PackageName.SubsystemName
zur Wahl des Namespace-Namens gefolgt werden, zum Beispiel
Microsoft.Logging.Listeners.
Formatierung des Codes
Die Formatierung schreibt vor, wie der Code strukturiert werden soll, wo welche
Klammern zu setzen und wo Leerzeichen einzufügen sind. Da die meisten Projektgruppenmitglieder
bisher nur Java programmiert haben, sind auch hier einige Änderungen
gegenüber dem Java-Coding-Style festzuhalten. Ein beispielhaftes Klassenlayout ist im
folgenden Listing (Listing 12.2) dargestellt. (vgl. [Krü03, HD05, Edm09]):
1 // Class layout based on accessibility
2 class Purchasing
3 {
4 #region var
5
6 #region constants
7
8 #region Start
9