Coding Conventions: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Keine Bearbeitungszusammenfassung |
|||
| (2 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
Mit [[Coding Conventions]] sind ein mehr oder weniger fester Satz von Regeln gemeint, an die sich alle an einem Projekt teilnehmenden Programmierer halten sollten um den Quellcode leichter les- und wartbar zu machen. | Mit [[Coding Conventions]] sind ein mehr oder weniger fester Satz von Regeln gemeint, an die sich alle an einem Projekt teilnehmenden Programmierer halten sollten um den Quellcode leichter les- und wartbar zu machen. | ||
Hierbei werden zum Beispiel Namenskonventionen und ihre Schreibweise ausgemacht. Aber auch auf die Einrückungstiefe des Quellcodes, das Benutzen von Leerzeichen oder Tabstopps sowie andere Richtlinien bei der Codeerstellung kann hier eingegangen werden. Zusätzlich beinhalten [[Coding Conventions]] meistens auch Vorgaben für die richtige [[Dokumentation]] des Codes. | Hierbei werden zum Beispiel Namenskonventionen und ihre Schreibweise ausgemacht. Aber auch auf die Einrückungstiefe des Quellcodes, das Benutzen von Leerzeichen oder Tabstopps sowie andere Richtlinien bei der Codeerstellung kann hier eingegangen werden. Zusätzlich beinhalten [[Coding Conventions]] meistens auch Vorgaben für die richtige [[Dokumentation]] des Codes. | ||
| Zeile 12: | Zeile 10: | ||
Die folgenden Namenskonventionen sind einzuhalten: | Die folgenden Namenskonventionen sind einzuhalten: | ||
* | * Typen und Namespaces: <tt>UpperCamelCase</tt> | ||
* | * Interfaces: <tt>IUpperCamelCase</tt> | ||
* | * Typ Parameter: <tt>TUpperCamelCase</tt> | ||
* | * Methoden, Properties und Events: <tt>UpperCamelCase</tt> | ||
* Lokale | * Lokale Variablen: <tt>lowerCamelCase</tt> | ||
* Lokale | * Lokale Konstanten: <tt>lowerCamelCase</tt> | ||
* | * Parameter: <tt>lowerCamelCase</tt> | ||
* | * Felder (nicht private): <tt>mUpperCamelCase</tt> | ||
* Instanzvariablen (private): <tt>mUpperCamelCase</tt> | * Instanzvariablen (private): <tt>mUpperCamelCase</tt> | ||
* Statische Felder (nicht private): <tt>sUpperCamelCase</tt> | * Statische Felder (nicht private): <tt>sUpperCamelCase</tt> | ||
* Konstante Felder (nicht private): <tt>UpperCamelCase</tt> | * Konstante Felder (nicht private): <tt>UpperCamelCase</tt> | ||
* Konstante Felder (private): <tt>UpperCamelCase</tt> | * Konstante Felder (private): <tt>UpperCamelCase</tt> | ||
* Statische | * Statische Readonly Felder (nicht private): <tt>sUpperCamelCase</tt> | ||
* Statische Readonly Felder (private): <tt>sUpperCamelCase</tt> | * Statische Readonly Felder (private): <tt>sUpperCamelCase</tt> | ||
* | * Enum Member: <tt>UpperCamelCase</tt> | ||
* Alles andere: <tt>UpperCamelCase</tt> | * Alles andere: <tt>UpperCamelCase</tt> | ||
