Styleguide

  • Einführung
    Absicht, Hintergrund und Anmerkungen zu diesem Styleguide.
  • Quelldateien
    Beschreibung des Aufbaus von Quelldateien mit Copyright-Block und uses-Klausel.
  • Namenskonventionen
    Wie steht es mit der Benennung von Units, Klassen, Variablen usw. und wie wichtig ist die Groß- und Kleinschreibung.
  • Verwendung des Leerzeichens
    Leerzeichen und -zeilen fördern die Lesbarkeit von Quellcode. Hier ist beschrieben, wo sie eingesetzt werden sollten.
  • Kommentare
    Kommentare erleichtern das Verständnis von Quellcode. Der Styleguide legt fest, was mit welchen Kommentarzeichen an welchen Stellen kommentiert werden darf.
  • Klassen
    Der Aufbau von Klassendeklarationen sowie die Verwendung der Sichtbarkeitsattribute public, private, protected und published.
  • Interfaces
    Aufbau von Interfaces.
  • Anweisungen
    Einfache und zusammengesetzte Anweisungen; wo darf und wo muss ein Zeilenumbruch stehen, wie werden lokale Variablen richtig deklariert und if-Anweisungen und Schleifen richtig formatiert.