Projektgruppe Visual Analytics - Medieninformatik und Multimedia ...

12.1 Coding Konventionen 205
• Für Schleifen-Konstrukte werden nur while oder foreach Schleifen verwendet,
da diese einfacher zu debuggen und logisch einfacher sind. Wird der Index des
aktuellen Schleifendurchlaufes in ein Statement miteinbezogen, ist auch die
Verwendung einer for Schleife möglich.
• Falls zu einem String-Objekt ein weiterer String hinzugefügt werden soll, wird
ein Objekt des Typs Stringbuilder verwendet, und nicht der Konkatenations-
Operator += des String-Objektes verwendet.
• Debug-Meldungen werden mit Hilfe der Debug.Assert() - Methode ausgegeben,
da das Ausgabe-Fenster der Debug-Konsole sehr schnell voll wird. Außerdem
wird so automatisch die Codezeilennummer mit angegeben. Das Listing 12.1
zeigt eine beispielhafte Anwendung dieses Debug-Konstrukts.
1 // Create an index for an array
2 int index;
3 // Perform some action that sets the index
4 // Test that the index value is valid.
5 Debug.Assert(index > -1);
Listing 12.1: Bedingungsfestlegung für eine Assertion
Grafische Komponenten, wie zum Beispiel MessageBox, werden nicht für Debug-
Meldungen verwendet.
Namenskonvention
In diesem Abschnitt wird die Freiheit zur Wahl von Namen für Dateien, Klassen,
Variablen, Methoden, etc. neben den allgemeinen Regeln aus dem vorherigen Abschnitt
weiter eingeschränkt. (vgl. [Krü03, HD05, Edm09])
Variablen werden klein geschrieben und erhalten einen mnemonischen Namen.
Dass heißt, dass zum Beispiel Indexvaribalen nicht als i deklariert werden,
sondern als index oder für eine temporäre Variable zum Beispiel swapInt
gewählt wird. Variablen werden so früh wie möglich deklariert. Eine Instanziierung
ist bei primitiven Datentypen nicht vorgesehen. Die Namen ergeben
sich aus der Konvention Adjektiv + Nomen + Qualifizierer, zum Beispiel
lowestCommonDenominator. Der Typ der Variable wird nicht im Variablennamen
mit angegeben, es wird damit die sogenannte hungarian notation nicht
verwendet. Für Exceptions und EventArgs wird der Variablenbuchstabe e
verwendet, sofern dieses möglich ist.
„Do not use Hungarian notation for field names. Good names describe
semantics, not type.“[Micf]