Quellcode Regeln für Delphi¶

Verwende die englische Sprache. Bei umgangssprachlich unüblichen englischen Wörtern kann eine deutsche Beschreibung in der Dokumentation des Sourcecodes verwendet werden.
Dateikopf muss vorhanden sein. (Filehead + Tab)
Nutze Namespaces und ordne die uses-Reihenfolge mit vollqualifizierten Namen, z.B. System.Utils
entferne nicht verwendete uses Anweisungen
vermeide Cycles in den uses Anweisungen, bzw. löse sie auf
Verwende die kleinstmögliche Sichtbarkeit nach außen, z.B. strict private.
Globale Variablen sollten vermieden werden. Sammle diese möglichst in einer Datei.
Achte auf Namenskonventionen und Präfixe f, T, v, a, c, I, E etc.
Namen für Klassen, Methoden, Variablen, etc. sollen aussagekräftig sein und ersparen Dokumentation.
Checke den Code etwas sauberer ein als du ihn ausgecheckt hast.
Gesetz von LeBlanc: Was du später machen willst, wirst du nie machen.
Besser nicht dokumentieren, als schlecht dokumentieren. Der Code sollte selbsterklärend sein.
Verwende keine Magic Numbers!
Erhöhe die Lesbarkeit und nutze die automatische Formatierung vom RAD Studio.
In einer Funktion muss Result zu Beginn initialisiert werden.
Vermeide z.B. Exit(-1), Exit(False), etc.. um aus einer Funktion frühzeitig rauszuspringen, es sei denn, es ist eine Startprüfung in der Funktion.
Verwende keine Namen von Firmen, aber verwende Namen von Zulieferern
Schreibe NUnit Tests, um deine Funktionen automatisch testen zu lassen. Jeder behobene Fehler sollte mit einem NUnit Test abgedeckt werden, soweit möglich!

Update 01.06.2023 - Kleinschreibung für - neue Projektstruktur

Quellcode Regeln für Python¶

PEP 8 – Style Guide for Python Code