Projektgruppe Visual Analytics - Medieninformatik und Multimedia ...

12.1 Coding Konventionen 207
10 #region Scale
11
12 #region Rotate
13
14 #region Translate
15 }
Listing 12.2: Definition von Regions zur Code-Strukturierung
Dies hat zur Folge, dass die Methoden einer Klasse nach der Funktionalität gegliedert
sind. Jede Methode ist entsprechend ihrer Funktionalität einzuordnen. Ebenso sind
Felder in die entsprechende Region einzuordnen. Eine weitere Unterstrukturierung
sollte, wenn möglich, eingefügt werden, damit die Übersicht erweitert wird. (vgl. [Krü03,
HD05, Edm09])
Des Weiteren gelten folgende Regeln:
• Der this-Zeiger ist vor eigenen Methodenaufrufen anzugeben.
• Bei der Verwendung von statischen Methoden oder Variablen einer Klasse ist der
Klassenname voranzustellen.
• Nach Methodenklammern folgt kein Leerzeichen, zum Beispiel MessageBox(String
message).
• Lange Befehlszeilen und Übergabeparameter werden in der Zeile umgebrochen.
Hierbei sollten nach Möglichkeit die Übergabeparameter in einer Zeile gruppiert
werden.
Kommentare
Zur Kommentierung von Klassen und Methoden wird die C# Dokumentierungsfunktion
verwendet, welche mit /// eingeleitet wird. Mit Hilfe dieser Dokumentierungsfunktion
sind alle Methoden und Klassen zu dokumentieren. Dabei ist nicht anzugeben, wie die
Klassen, bzw. Methoden etwas machen (wird bereits durch den Quellcode ausgedrückt),
sondern welchen Zweck diese Funktionalität erfüllt. Außerdem stehen verschiedene
Möglichkeiten zur Verfügung, um im Quellcode Kommentare einzufügen. Von dieser
Möglichkeit ist ausgiebig Gebrauch zu machen, besser ist es jedoch, Kommentare nicht
einfügen zu müssen, da der Code und die Variablennamen bereits aussagekräftig sind.
Um einzelne Zeilen zu kommentieren, wird diese direkt nach dem Abschluss des Befehls
dokumentiert.
1 private string name = string.Empty; // Name of control ( defaults to blank)
Listing 12.3: Beispielhafter Kommentar