Regeln für die Quellcodeformatierung
Aus Invertika Wiki
Hier werden bestimmte Richtlinien für die Formatierung des Sourcecodes erläutert damit dieser möglichst gleich aussieht.
Inhaltsverzeichnis |
Allgemeine Richtlinien
C/C++
C#
LUA
- LUA Dateinamen sind immer klein zu schreiben
- Einrücken mit Leerzeichen (4 Stück pro Einrückung)
- Einrücken von mehrzeiligen Anweisungen mit 2 zusätzlichen Leerzeichen (bei allen Zeilen außer der ersten)
- Klassennamen werden in UpperCamelCase geschrieben z.B. PokerEngine
- Gehören mehre Klassen zu einer Bibliothek (z.B. Poker) so werden diese Klassen in einen Unterordner gepackt z.B. libs/poker/pokerengine.lua
Python
- Python Dateinamen sind immer klein zu schreiben
- Einrücken mit Leerzeichen (4 Stück pro Einrückung)
XML
- Einrücken mit Leerzeichen (4 Stück pro Einrückung)
- Es sollte sich am Format der restlichen Datei orientiert werden
items.xml
- Jedes Attribut eines <item>-Elementes kommt in eine neue Zeile, diese Zeilen sind jeweils durch 4 Leerzeichen gegenüber der ersten Zeile der Item-Definition eingerückt
- Hat ein Item-Element keine Unterelemente, wird die Kurzschreibweise (<item />) gewählt
- Hat ein Item-Element Unterelemente, wird das abschliessende </item>-Tag auf gleiche Höhe eingerückt wie das beginnende <item>-Tag
- Unterelemente eines Item-Elements werden mit 4 Leerzeichen gegenüber dem <item>-Tag eingerückt
- Nach dem Ende des einleitenden <item>-Tags folgt vor Unterelementen zwecks besserer Lesbarkeit eine Leerzeile
- Es dürfen keine Tabs verwendet werden
