Einleitung

Motivation

Diese Richtlinien zur Codierung entstanden (und entstehen) im Rahmen meiner täglichen Arbeit und versuchen

den Code lesbarer zu machen und
bereits bei der Codierung Fehler früh zu erkennen oder zu verhindern.

Die Richtlinien wurden, soweit möglich, programmiersprachenunabhängig entworfen. Die Beispiele sind jedoch in C++ angegeben, da dies die Programmiersprache ist, in der ich vorwiegend arbeite. An Stellen, in denen auf programmiersprachenabhängige Ausnahmen hingewiesen wird, finden jedoch auch andere Sprachen Verwendung. Sätze bzw. Absätze, die nur für eine bestimmte Programmiersprache von Bedeutung sind, werden durch den Namen der betreffenden Sprache in Klammern eingeleitet (z.B.: (C++) ).

Gelegentlich sind jedoch Einschränkungen erforderlich, weil die 'reine Lehre' aus Effizienzgründen eher hinderlich ist (manchmal steht eben nicht ein 'fliegender Ziegelstein'¹ wie ein Pentium, sondern nur ein gewöhnlicher Microcontroller einer Waschmaschine zur Verfügung) oder weil die verwendete Programmiersprache selbst nicht mächtig genug ist. Soweit erforderliche Ausnahmen abzusehen sind oder bereits benötigt wurden, wurden sie in diesem Dokument berücksichtigt.

Im Augenblick sind die Möglichkeiten des angekündigten ANSI-Standards für C++ wie z.B. name spaces noch nicht berücksichtigt. Außerdem habe ich gerade entdeckt, daß es einen ADA 9x style guide gibt, den ich (noch) nicht kenne.

Richtlinien werden i. a. immer für einen bestimmten Kontext erstellt. Es gibt keinen 'katholischen' Programmierstil (und wenn, dann wird er nicht in diesem Dokument beschrieben :-). Wenn bestimmte Richtlinien für Sie ungeeignet erscheinen, können Sie das Dokument ja als Richtlinie zur Erstellung von Richtlinien verwenden.

Danke

Ein Dokument in der vorliegenden Art lebt von den Anregungen und der Mitarbeit vieler Leute. An dieser Stelle möchte ich den Leuten danken, die Material beigesteuert haben (dies sind insbesondere R.Marx und meine damaligen Mitarbeiter bei ela soft) und beisteuern werden. Ich freue mich jedenfalls immer über konstruktive Anregungen jeder Art, die mich unter

uwe-sauerland@t-online.de

erreichen.

Berlin, 30. Mai 1997

¹ Eine Anspielung auf einen ansonsten bedeutungslosen B-Film, in dem der Commodore seinem Geschwader erklärt, die McDonnel-Douglas F4 (Phantom) sei "Amerikas Beweis an die Welt, daß auch ein Ziegelstein fliegen kann, wenn man Tragflächen und ein starkes Triebwerk dranschraubt."