## Kommentare. Selbstverständlichkeiten sollen nicht dokumentiert werden. Kommentare sollten so gestaltet werden, daß mit ihrer Hilfe durch DokumentationsTool eine brauchbare Dokumentation erzeugt werden kann. ::Das verwendete Tool wird in dem jeweiligen Projekt festgelegt. |
* Es werden nur die für die jeweilige Programmiersprache typischen, einfachen Sourcefile-Extension verwendet: z.B. ".c", ".cpp", ".java", ".pl", ".h" oder ".hpp". Unzulässigtwäre z.B. ein C-Sourcefile mit der Extension ".cx" oder ".x.c". * Die Benennung von Files soll sich nicht darauf stützen, dass das Betriebssystem Groß-/Kleinschreibung unterscheidet bzw. mehrere Extensions in einem Filenamen zuläßt. * Vorschriften über die Länge von Zeilen (nicht zu lang) oder die Formatierung von Kommentaren werden dem guten Geschmack der beteiligten Programmierer überlassen. |
* Es werden nur die für die jeweilige Programmiersprache typischen, einfachen Sourcefile-Extension verwendet: z.B. ".c", ".cpp", ".java", ".pl", ".h" oder ".hpp". Unzulässig wäre z.B. ein C-Sourcefile mit der Extension ".cx" oder ".x.c". |
* Kommentare sollten so gestaltet werden, daß mit ihrer Hilfe durch DokumentationsTool eine brauchbare Dokumentation erzeugt werden kann. Das verwendete Tool wird in dem jeweiligen Projekt festgelegt. |
* Die Benennung von Files soll sich nicht darauf stützen, dass das Betriebssystem Groß-/Kleinschreibung unterscheidet bzw. mehrere Extensions in einem Filenamen zuläßt. |
* Die Entwicklungstools sollten frei verfügbar sein |
* Die Fileorganisation soll dem Modul- bzw. Klassenaufbau entsprechen. |
* Die Programme sollten über eine Hilfsfunktion mit einer Beschreibung der Parameter verfügen |
* Vorschriften über die Länge von Zeilen (nicht zu lang) oder die Formatierung von Kommentaren werden dem guten Geschmack der beteiligten Programmierer überlassen. |
* Die Fileorganisation soll dem Modul- bzw. Klassenaufbau entsprechen. |
* Programme sollten über eine Hilfsfunktion mit einer Beschreibung der Parameter verfügen. |
KategorieDokumentation |
KategorieDokumentation KategorieProgrammierStil |
Zuletzt gemachte Änderungen sollen durch Fettschrift markiert werden.
Autoren: HelmutLeitner, RalfEbert
Diskussion siehe ProgrammierStilAlphaDiskussion
Einleitung |
Regeln |
Triviale Regeln |