Softwareentwicklung in C++ - ASC

A. Coding-Standard
Der hier angeführte Coding-Standard ist ein Vorschlag, wie ein solcher aussehen
könnte. Zu erwähnen wäre, dass die hier abgedruckte Version eine
sinnvolle Minimalversion für kleine Projekte darstellt. Für große Projekte
sind entsprechend weitere Regeln zu ergänzen.
A.1 Generelle Regeln
Die folgenden Prinzipien sind essentiell für die Lesbarkeit, Wartbarkeit und
Erweiterbarkeit eines Programms:
Einfachheit: Das Prinzip der Einfachheit ist auch als das KISS-Prinzip (Keep
It Small and Simple) bekannt. Kurz gesagt sollen Methoden, Funktionen
und natürlich auch Operatoren genau eine, für ihren Abstraktionslevel
adäquate, atomare Aufgabe erfüllen. Niemals sollen mehrere Aufgaben
auf einmal erledigt werden, genauso wenig, wie Aufgaben erledigt werden
sollen, die in einen anderen Abstraktionslevel gehören (=Durchgriff nach
unten oder oben). Parameterlisten sollen so kurz und übersichtlich wie
möglich gehalten werden. Methoden, Operatoren und Funktionen sollen
als Faustregel niemals mehr als 60 Zeilen lang sein. Eine durchschnittliche
Länge von ca. 30 Zeilen ist zu bevorzugen. Seiteneffekte sind absolut zu
vermeiden!
Das Prinzip der Einfachheit bedingt auch, dass Klassen keine fetten Interfaces
haben dürfen.
Intuitivität: Das Prinzip der Intuitivität bedeutet, dass man den geschriebenen
Source-Code “wie ein Buch” lesen und verstehen können muss,
und zwar ohne Kommentare im Source-Code und ohne Erklärungen des
Programmierers! Damit ist impliziert, dass Variablen-, Methoden- und
Funktionsnamen sprechend (=selbsterklärend) und genau ihrer Funktionalität
entsprechend benannt sein müssen. Einbuchstabenvariablen,
wie z.B. i, sind nicht erlaubt. Unnötige Kommentare werden als störend
erachtet und sollen dementsprechend weggelassen werden. Ein typisches
Beispiel für solche unnötigen Kommentare wäre:
count++; // and here the counter is incremented