-do {
- ...
-} until ($a > 0);</pre></li><li class="listitem"><p>Parameter von Funktionsaufrufen müssen mit runden Klammern
- versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
- und grep-ähnliche Operatoren. Beispiel:</p><pre class="programlisting">$main::lxdebug->message("Could not find file.");
-%options = map { $_ => 1 } grep { !/^#/ } @config_file;</pre></li><li class="listitem"><p>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</p><p>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
- Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
- Blöcke schon. Beispiel:</p><pre class="programlisting">if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
- ...
-}
-
-$array[$i + 1] = 4;
-$form->{sum} += $form->{"row_$i"};
-$form->{ $form->{index} } += 1;
-
-map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</pre></li><li class="listitem"><p>Mehrzeilige Befehle</p><div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"><p>Werden die Parameter eines Funktionsaufrufes auf mehrere
- Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
- werden, in der die ersten Funktionsparameter in der ersten Zeile
- stehen. Beispiel:</p><pre class="programlisting">$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
- $form->{some_col_value});</pre></li><li class="listitem"><p>Ein Spezialfall ist der ternäre Oprator "?:", der am
- besten in einer übersichtlichen Tabellenstruktur organisiert
- wird. Beispiel:</p><pre class="programlisting">my $rowcount = $form->{"row_$i"} ? $i
- : $form->{oldcount} ? $form->{oldcount} + 1
- : $form->{rowcount} - $form->{rowbase};</pre></li></ol></div></li><li class="listitem"><p>Kommentare</p><div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"><p>Kommentare, die alleine in einer Zeile stehen, sollten
- soweit wie der Code eingerückt sein.</p></li><li class="listitem"><p>Seitliche hängende Kommentare sollten einheitlich
- formatiert werden.</p></li><li class="listitem"><p>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
- auf Englisch zu verfassen. So wie ich keine Lust habe,
- französischen Quelltext zu lesen, sollte auch der kivitendo
- Quelltext für nicht-Deutschsprachige lesbar sein.
- Beispiel:</p><pre class="programlisting">my $found = 0;
-while (1) {
- last if $found;
-
- # complicated check
- $found = 1 if //
-}
-
-$i = 0 # initialize $i
-$n = $i; # save $i
-$i *= $const; # do something crazy
-$i = $n; # recover $i</pre></li></ol></div></li><li class="listitem"><p>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
- Interpolation gewünscht ist. Beispiel:</p><pre class="programlisting">$form->{sum} = 0;
-$form->{"row_$i"} = $form->{"row_$i"} - 5;
-$some_hash{42} = 54;</pre></li><li class="listitem"><p>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
- unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
- wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
- grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</p><p>Als Beispiel sei die Funktion
- <code class="function">print_options</code> aus
- <code class="filename">bin/mozilla/io.pl</code> angeführt.</p></li><li class="listitem"><p>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
- unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
- verfälschen.</p><p>Emacs und vim haben beide recht einfache Methoden zur
- Entfernung von trailing whitespace. Emacs kennt das Kommande
- <span class="command"><strong>nuke-trailing-whitespace</strong></span>, vim macht das gleiche
- manuell über <code class="literal">:%s/\s\+$//e</code> Mit <code class="literal">:au
- BufWritePre * :%s/\s\+$//e</code> wird das an Speichern
- gebunden.</p></li><li class="listitem"><p>Es wird kein <span class="command"><strong>perltidy</strong></span> verwendet.</p><p>In der Vergangenheit wurde versucht,
- <span class="command"><strong>perltidy</strong></span> zu verwenden, um einen einheitlichen
- Stil zu erlangen. Es hat sich aber gezeigt, dass
- <span class="command"><strong>perltidy</strong></span>s sehr eigenwilliges Verhalten, was
- Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
- den Interessierten sind hier die
- <span class="command"><strong>perltidy</strong></span>-Optionen, die grob den beschriebenen
- Richtlinien entsprechen:</p><pre class="programlisting">-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
--aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
--lp -vt=1 -vtc=1</pre></li><li class="listitem"><p>
- <code class="varname">STDERR</code> ist tabu. Unkonditionale
- Debugmeldungen auch.</p><p>kivitendo bietet mit dem Modul <code class="classname">LXDebug</code>
- einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
- Grund, nach <code class="varname">STDERR</code> zu schreiben.</p><p>Die <code class="classname">LXDebug</code>-Methode
- "<code class="function">message</code>" nimmt als ersten Paramter außerdem
- eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
- angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
- und werden in den meisten Fällen auch vom Repository
- zurückgewiesen.</p></li><li class="listitem"><p>Alle neuen Module müssen use strict verwenden.</p><p>
- <code class="varname">$form</code>, <code class="varname">$auth</code>,
- <code class="varname">$locale</code>, <code class="varname">$lxdebug</code> und
- <code class="varname">%myconfig</code> werden derzeit aus dem main package
- importiert (siehe <a class="xref" href="ch04.html#devel.globals" title="4.1. Globale Variablen">Globale Variablen</a>. Alle anderen
- Konstrukte sollten lexikalisch lokal gehalten werden.</p></li></ol></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch04s04.html">Zurück</a> </td><td width="20%" align="center"><a accesskey="u" href="ch04.html">Nach oben</a></td><td width="40%" align="right"> <a accesskey="n" href="ch04s06.html">Weiter</a></td></tr><tr><td width="40%" align="left" valign="top">4.4. Translations and languages </td><td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td><td width="40%" align="right" valign="top"> 4.6. Dokumentation erstellen</td></tr></table></div></body></html>
\ No newline at end of file