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