C-Programmierung
Einrückung von Kontrollstrukturen und Quellcode-Formatierung
← Beispiele zu Kontrollstrukturen | ● | Präprozessor Direktiven →
Die drei Hauptziele bei der Quellcode-Formatierung:
- Lesbarer Quellcode
- Nachvollziehbarer Quellcode
- Dokumentierter Quellcode
Formatierungsregeln:
- Titelkommentar mit Autor und Projektname
- Ein Befehl pro Zeile
- Anweisungsblöcke werden eingerückt
- Leerzeichen dort, wo sie die Lesbarkeit erhöhen
- mindestens nach
= , if while && || - aber nicht nach Funktionsnamen und
( * / %
- mindestens nach
- Leerzeilen dort, wo sie logische Blöcke trennen
- mindestens nach Deklarations- und Funktionsblock
- empfohlen zwischen verschiedenen Kontrollstrukturen derselben Ebene
- [einzeilige] Kommentare vor einem längeren logischen Block
- [mehrzeiliger] Kommentar vor jeder Funktion
- kurze Beschreibung der Funktion
- Beschreibung der Parameter und spezieller Argumente
- Keine Tabs (Einrückung = 3 Leerzeichen!)
Allgemeines Einrückungsschema:
{
...;
...;
}
...;
...;
}
Alternatives Schema bei if/while:
if (...) {
...;
...;
}
...;
...;
}
← Beispiele zu Kontrollstrukturen | ● | Präprozessor Direktiven →