Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
1. Wichtige

Tipps für die Zusammenarbeit am Quellcode  


Tip

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

Image Added


Tip

Grundsätzlich verwenden wir als Indentation

Character

 Style (Einrückung) den Tabulator mit der Weite (4). Bitte keine Spaces (Leerzeichen) verwenden.

Wie im nachfolgendem Bild

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

Abbildung 1Image Added

Tip

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

Abbildung 2Image Added

Tip

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ätenstens ein

sollte spätestens ein Umbruch erfolgen.

Korrekte Formatierung

Abbildung 3Image Added

Tip

So wie hier zusehen, sollten grundsätzlich auch Kommentare

sollten über der Zeile notiert werden,sollten sie für eine 130 Zeichen Zeile zu lang sein

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

Abbildung 4Image Added

Tip

Die Schlusszeile jeder Datei muss mit einer Leerzeile enden. Atlassians Sourcetree wirft sonst einen Fehler in gewissen Situationen.

Header Block & Updates

Abbildung 5Image Added

Tip

Der Header Block sollte wie

nachfolgend

im Bild aussehen. Insbesondere der Teil

des Updates,wie im Bild zu sehen.

des Update Bereiches sollte gut ersichtlich und chronologisch mit dem Namen des Coders vermerkt sein.

Ordner Hierarchie & Abhängigkeiten

Abbildung 6Image Added

Tip

Noch ein Hinweis zur

Ordnerstruktur

Ordner Struktur des Projektes. Sollte es unvermeidbar sein, Unity Abhängigkeiten

auflösen zu

können

müssen, so

sollte

sollten diese

entsprechende Datei

entsprechenden Dateien, in der selben Order Struktur weiter unten

untenunter dem

im Verzeichnis UNITY und im entsprechendem Namespace

eingehangen

ein gehangen werden. Wir haben

so

damit einen

zentralen

Ort,

wo wir

die Abhängigkeiten zentralisieren zu können.

Zudem empfehle ich die Schriftart Source Code Pro.



Panel

Auf dieser Seite:

Table of Contents



Tip

Ich empfehle es Dir, hier mit dem Lesen zu beginnenZudem empfehle ich die Schriftart Source Code Pro mit einer festen Zeilenweite.



Zugehörige Seiten

Filter by label (Content by label)
showLabelsfalse
spacesUNITY
showSpacefalse
sorttitle
typepage
cqllabel = "documentation-space-sample" and type = "page" and space = "UNITY"
labelsdocumentation-space-sample