Coding style

Aus Old Ethersex
Wechseln zu: Navigation, Suche

Inhaltsverzeichnis

Allgemeine Richtlinien

Damit die Code Basis lesbar bleibt, sollten einige Formatierungsregeln eingehalten werden. Es finden sich weitere Hinweise auch in Eigenes Modul hinzufügen.

Nachdem Ethersex auch einigen importierten Code enthält, unterscheiden sich die Formatierungsregeln zum Teil zwischen den einzelnen Modulen. Das ist soweit wohl auch kein größeres Problem, du solltest aber versuchen, deine Ergänzungen an das vorgefundene Layout anzupassen (:mrgreen:)

Verbindliche Grundsätze

  • Lizenzkopf einstellen.
  • Zeilen > 80 Zeichen vermeiden.
  • ein Tabulator entspricht 8 Zeichen; eigentlich Standard in allen gängigen Editoren, das dann bitte auch so lassen. Wenn Du Code auf bspw. 4 Zeichen ausrichten willst, dann mit Leerzeichen füllen, nicht den Tabstop auf 4 Zeichen abändern!
    • Ausnahmen: mca25-Code (importierter Code mit Tabstop=2)

Empfehlungen (wenn nicht bereits anders praktiziert)

  • Geschweiftle Klammern immer in einer eigenen Zeile führen.
  • Einrückungen beachten. Mit Tabulatoren nicht mit Leerzeichen arbeiten.
  • KEINE Texteditor spezifischen Formatierungsregeln irgendwo plazieren.
  • Makros sollten direkt unter den includes definiert werden und nicht gemischt zwischen dem Code stehen.

Funktionen

In header Dateien Funktionen wie folgt definieren:

void func(void);

In Quellcode Dateien Funktionen wie folgt implementieren:

void
func(void)
{
  /* content */
}
Meine Werkzeuge
Namensräume

Varianten
Aktionen
Navigation
Werkzeuge