Antares Open World Development Documentation
Coding Guidelines
- Jan Ohlmann | PO
Tipps für die Zusammenarbeit am Quellcode
Gerne möchte ich Euch animieren, alle notwendigen Informationen im Quellcode Header einer Implementierungsdatei am Laufen zu halten. Dies trägt einer formellen und chronologisch sauberen ersichtlichen Mitarbeit an der jeweiligen ausgekoppelten Implementierung bei. Ebenso setzt Ihr so, die Rahmenbedingungen, wie Rechtevergabe, Zusammenarbeit und Veränderungen vollzogen werden. Lasst uns professionell implementieren!
Aufbau des Datei Headers
Grundsätzlich verwenden wir als Indentation Style (Einrückung) den Tabulator mit der Weite (4). Bitte keine Spaces (Leerzeichen) verwenden. Erlaubt sind Leerzeichen jedoch, um fehlende Zeichenweiten kleiner 4 Leerzeichen aufzufüllen, zum Beispiel um 2 Operatoren [+, - , * , /] nach einem Umbruch untereinander bündig darstellen zu können.
Namespace und Tabulator Einrückung
Wie in der Abbildung darüber zu sehen, sollten die Kommentar Blöcke an der linken Seite bündig beginnen. Der Namespace oben sollte zusammen mit using einen Tab nach rechts verschoben werden.
Kommentare & Umbruch
Kommentare beginnen einen Tab Einzug früher und sollten bündig mit dem Quellcode sein. Die maximale Zeilenbreite liegt bei 130 Zeichen, dann sollte spätestens ein Umbruch erfolgen.
Korrekte Formatierung
So wie hier zusehen, sollten grundsätzlich auch Kommentare nicht über die 130iger Seitenbegrenzung geschrieben werden. Bei einem Umbruch sollten die Funktionsoperatoren [+, - , * /], dann links bündig die Funktion darstellen und möglichst nach einem Komma [,] umgebrochen werden.
Konvention Schlusszeile
Die Schlusszeile jeder Datei muss mit einer Leerzeile enden. Atlassians Sourcetree wirft sonst einen Fehler in gewissen Situationen.
Header Block & Updates
Der Header Block sollte wie im Bild aussehen. Insbesondere der Teil des Update Bereiches sollte gut ersichtlich und chronologisch mit dem Namen des Coders vermerkt sein.
Ordner Hierarchie & Abhängigkeiten
Noch ein Hinweis zur Ordner Struktur des Projektes. Sollte es unvermeidbar sein, Unity Abhängigkeiten auflösen zu müssen, so sollten diese entsprechenden Dateien, in der selben Order Struktur weiter unten im Verzeichnis UNITY und im entsprechendem Namespace ein gehangen werden. Wir haben damit einen Ort, die Abhängigkeiten zentralisieren zu können.
Auf dieser Seite:
Zudem empfehle ich die Schriftart Source Code Pro mit einer festen Zeilenweite.
Zugehörige Seiten
Filter by label
There are no items with the selected labels at this time.