X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fch04s05.html;h=9d3743f079daf0aaa39a4a361072f0fac670c84f;hb=075bd42af8885aee3c18fe055a2c82b8b43f4cea;hp=92765aeac97826a277d2a690453a09eed2cd2e32;hpb=b948bb619c8086b8f05aac962d44d075aea17822;p=kivitendo-erp.git diff --git a/doc/html/ch04s05.html b/doc/html/ch04s05.html index 92765aeac..9d3743f07 100644 --- a/doc/html/ch04s05.html +++ b/doc/html/ch04s05.html @@ -1,6 +1,6 @@ - 4.5. Stil-Richtlinien

4.5. Stil-Richtlinien

Die folgenden Regeln haben das Ziel, den Code möglichst gut les- + 4.5. Stil-Richtlinien

4.5. Stil-Richtlinien

Die folgenden Regeln haben das Ziel, den Code möglichst gut les- und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden wird (Stichworte "Klammern" oder "Hash-Keys").

Diese Regeln sind keine Schikane sondern erleichtern allen das @@ -66,7 +66,7 @@ map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;

  • Seitliche hängende Kommentare sollten einheitlich formatiert werden.

  • 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 Lx-Office + französischen Quelltext zu lesen, sollte auch der kivitendo Quelltext für nicht-Deutschsprachige lesbar sein. Beispiel:

    my $found = 0;
     while (1) {
    @@ -105,7 +105,7 @@ $some_hash{42}    = 54;
  • Die maximale Zeilenlä -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79 -lp -vt=1 -vtc=1

  • STDERR ist tabu. Unkonditionale - Debugmeldungen auch.

    Lx-Office bietet mit dem Modul LXDebug + Debugmeldungen auch.

    kivitendo bietet mit dem Modul LXDebug einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen Grund, nach STDERR zu schreiben.

    Die LXDebug-Methode "message" nimmt als ersten Paramter außerdem