Bezeichner; Ausdrücke; Funktionsdefinitionen - Conrad C-Control II Unit Handbuch

6 Softwareentwicklung

6.3.3 Bezeichner

1. Bezeichner sollen selbstbeschreibend sein. Abkürzungen sind möglich, solange die
Bedeutung im Kontext ohne zusätzliche Kommentare erkennbar bleibt. Zum Beispiel
"getMaxTemp" statt "getMaximumTemperature" ist zulässig. Nur primitive Funktionen,
temporäre Variablen zur Speicherung von Zwischenergebnissen, Indizes oder
Schleifenvariablen, dürfen aus einzelnen Buchstaben oder kurzen Zeichen-
kombinationen bestehen.
2. Bezeichner von Modulen, Threads, Funktionen und Variablen beginnen mit einem
Kleinbuchstaben.
3. Bezeichner von zusammengesetzten Datentypen beginnen mit einem Groß-
buchstaben.
4. Bezeichner von Konstanten bestehen nur aus Großbuchstaben, Unterstrichen und
Ziffern.
5. Bezeichner von Funktionen sollten weitestgehend mit einem Verb oder einer üblichen
Abkürzung eines Verbs beginnen (z.B get, set, put, write, init, calc ...)
6. In längeren Bezeichnern sind einzelne Worte durch Unterstriche oder einzelne
Großbuchstaben an Wortwechseln zu trennen, z.B. getMaxTemp oder get_max_temp.
Die einmal gewählte Schreibweise ist beizubehalten.
7. Bezeichner sind in einer einzigen Sprache verfaßt, z.B. einheitlich englischsprachig
oder einheitlich deutschsprachig. Bezeichner sind in derselben Landessprache wie die
Kommentare zu formulieren.
6.3.4 Ausdrücke
Komplexe numerische Ausdrücke sind durch Klammersetzung und Leerzeichen so zu
gestalten, daß Teilausdrücke optisch erkennbar sind.

6.3.5 Funktionsdefinitionen

1. Die Definitionszeilen sind durch "//-----" -Kommentarzeilen gerahmt (siehe
Standardmodulquelltexte). Zwischen diesen Kommentarzeilen steht nichts außer der
Funktionsdefinition.
2. Eine Definitionszeile beginnt mit einer Einrückung von zwei Leerzeichen.
3. Rechts und links der runden Klammern steht ein Leerzeichen, z.B. function fx ( int
param ). Bei Funktionen ohne Parameter entfallen die Leerzeichen innerhalb der run-
den Klammern, z.B. function fx ().
4. Bei Funktionsdefinitionen mit mehreren Parametern steht nach jedem Komma in der
Liste der formalen Parameter ein Leerzeichen, z.B. function fx ( int a, int b, int c )
89