4 Die folgenden Regeln haben das Ziel, den Code möglichst gut les- und wartbar
5 zu machen. Dazu gehört zum Einen, dass der Code einheitlich eingerückt ist,
6 aber auch, dass Mehrdeutigkeit so weit es geht vermieden wird (Stichworte
7 "Klammern" oder "Hash-Keys").
9 Diese Regeln sind keine Schikane, sondern erleichtern allen das Leben!
11 Jeder, der einen Patch schickt, sollte sein Script vorher durch perltidy
12 laufen lassen. Damit werden einige der nachfolgenden Regeln automatisch
13 befolgt, andere hingegen nicht. Dort, wo keine perltidy-Optionen angegeben
14 sind, muss der Programmierer selbst für die Einhaltung sorgen.
16 --------------------------------------------------------------------------
18 1. Es werden keine "echten" TAB-Zeichen sondern Leerzeichen verwendet.
20 2. Die Einrückung beträgt zwei Leerzeichen.
24 print(STDERR "Debugging.\n");
27 3. Öffnende geschweifte Klammern befinden sich auf der gleichen Zeile wie
37 if ($form->{item_rows} > 0) {
41 4. Schließende geschweifte Klammern sind so weit eingerückt wie der Befehl/
42 die öffnende schließende Klammer, die den Block gestartet hat, und nicht
43 auf der Ebene des Inhalts. Die gleichen Beispiele wie bei 3. gelten.
45 5. Die Wörter "else" "elsif", "while" befinden sich auf der gleichen
46 Zeile wie schließende geschweifte Klammern.
49 if ($form->{sum} > 1000) {
51 } elsif ($form->{sum} > 0) {
61 6. Parameter von Funktionsaufrufen müssen mit runden Klammern versehen
62 werden. Davon nicht betroffen sind interne perl Funktionen.
66 $main::lxdebug->message("Could not find file.");
67 %options = map { $_ => 1 } grep { !/^#/ } @config_file;
69 7. Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:
71 Generell gilt: Hashkeys und Arrayindices sollten _nicht_ durch Leerzeichen
72 abgesetzt werden. Logische Klammerungen ebensowenig, Blöcke schon.
77 if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
82 $form->{sum} += $form->{"row_$i"};
83 $form->{ $form->{index} } += 1;
85 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;
87 8. Mehrzeilige Befehle
89 8.1 Werden die Parameter eines Funktionsaufrufes auf mehrere Zeilen
90 aufgeteilt, so sollten diese bis zu der Spalte eingerückt werden,
91 in der die ersten Funktionsparameter in der ersten Zeile stehen.
94 $sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
95 $form->{some_col_value});
97 8.3 Ein Spezialfall ist der ternäre Oprator "?:", der am besten in einer
98 übersichtlichen Tabellenstruktur organisiert wird.
102 my $rowcount = $form->{"row_$i"} ? $i
103 : $form->{oldcount} ? $form->{oldcount} + 1
104 : $form->{rowcount} - $form->{rowbase};
108 9.1 Kommentare, die alleine in einer Zeile stehen, sollten soweit wie der
109 Code eingerückt sein.
110 9.2 Seitliche hängende Kommentare sollten einheitlich formatiert werden.
112 9.3 Sämtliche Kommentare und Sonstiges im Quellcode ist bitte auf Englisch
113 zu verfassen. So wie ich keine Lust habe französischen Quelltext zu lesen,
114 sollte auch der Lx-Office Quelltext für nicht-Deutschsprachige lesbar sein.
126 $i = 0 # initialize $i
128 $i *= $const; # do something crazy
129 $i = $n; # recover $i
131 10. Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation
137 $form->{"row_$i"} = $form->{"row_$i"} - 5;
140 11. Die Maximale Zeilenlänge ist nicht bescränkt. Zeilenlängen <= 79
141 helfen unter bestimmten Bedingungen, aber wenn die Lesbarkeit unter
142 kurzen Zeilen leidet (wie zum Biespiel in grossen Tabellen), dann
143 ist Lesbarkeit vorzuziehen.
145 Als Beispiel sei print_options aus bin/mozilla/io.pl angeführt.
147 12. Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind unerwünscht.
148 Sie führen zu unnötigen Whitespaceänderungen die diffs verfälschen.
150 Emacs und vim haben beide recht einfach Methoden dafür:
151 emacs kennt das Kommande nuke-trailing-whitespace,
152 vim macht das gleiche manuell über :%s/\s\+$//e
154 12. Es wird kein perltidy verwendet.
156 In der Vergangenheit wurde versucht perltidy zu verwenden um einen
157 einheitlichen Stil zu erlangen, es hat sich aber gezeigt, dass Perltidys
158 sehr eigenwilliges Verhaltes was Zeilenumbrüche angeht oftmals gut
159 formatierten Code zerstört. Für den Interessierten, hier sind die perltidy
160 Optionen die grob den beschriebenen Richtlinien entsprechen.