Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision 5fa26f9a

Von Moritz Bunkus vor etwa 12 Jahren hinzugefügt

  • ID 5fa26f9a276487b08665bcefe36986bb66b9a3d7
  • Vorgänger 692e001f
  • Nachfolger 6d8b737a

Dokumentation: Lx-Office in kivitendo umbenennen

Unterschiede anzeigen:

doc/html/ch04s05.html
1 1 
<html><head>
2 2 
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
3 
   <title>4.5. Stil-Richtlinien</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1-RC2"><link rel="home" href="index.html" title="Lx-Office: Installation, Konfiguration, Entwicklung"><link rel="up" href="ch04.html" title="Kapitel 4. Entwicklerdokumentation"><link rel="prev" href="ch04s04.html" title="4.4. Translations and languages"><link rel="next" href="ch04s06.html" title="4.6. Dokumentation erstellen"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.5. Stil-Richtlinien</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04s04.html">Zurück</a>&nbsp;</td><th width="60%" align="center">Kapitel 4. Entwicklerdokumentation</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch04s06.html">Weiter</a></td></tr></table><hr></div><div class="sect1" title="4.5. Stil-Richtlinien"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="devel.style-guide"></a>4.5. Stil-Richtlinien</h2></div></div></div><p>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
3 
   <title>4.5. Stil-Richtlinien</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1-RC2"><link rel="home" href="index.html" title="kivitendo: Installation, Konfiguration, Entwicklung"><link rel="up" href="ch04.html" title="Kapitel 4. Entwicklerdokumentation"><link rel="prev" href="ch04s04.html" title="4.4. Translations and languages"><link rel="next" href="ch04s06.html" title="4.6. Dokumentation erstellen"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.5. Stil-Richtlinien</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04s04.html">Zurück</a>&nbsp;</td><th width="60%" align="center">Kapitel 4. Entwicklerdokumentation</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch04s06.html">Weiter</a></td></tr></table><hr></div><div class="sect1" title="4.5. Stil-Richtlinien"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="devel.style-guide"></a>4.5. Stil-Richtlinien</h2></div></div></div><p>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
4 4 
      und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5 5 
      eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6 6 
      wird (Stichworte "Klammern" oder "Hash-Keys").</p><p>Diese Regeln sind keine Schikane sondern erleichtern allen das
......
66 66 
              soweit wie der Code eingerückt sein.</p></li><li class="listitem"><p>Seitliche hängende Kommentare sollten einheitlich
67 67 
              formatiert werden.</p></li><li class="listitem"><p>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
68 68 
              auf Englisch zu verfassen. So wie ich keine Lust habe,
69 
              französischen Quelltext zu lesen, sollte auch der Lx-Office
69 
              französischen Quelltext zu lesen, sollte auch der kivitendo
70 70 
              Quelltext für nicht-Deutschsprachige lesbar sein.
71 71 
              Beispiel:</p><pre class="programlisting">my $found = 0;
72 72 
while (1) {
......
105 105 
-aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
106 106 
-lp -vt=1 -vtc=1</pre></li><li class="listitem"><p>
107 107 
                  <code class="varname">STDERR</code> ist tabu. Unkonditionale
108 
          Debugmeldungen auch.</p><p>Lx-Office bietet mit dem Modul <code class="classname">LXDebug</code>
108 
          Debugmeldungen auch.</p><p>kivitendo bietet mit dem Modul <code class="classname">LXDebug</code>
109 109 
          einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
110 110 
          Grund, nach <code class="varname">STDERR</code> zu schreiben.</p><p>Die <code class="classname">LXDebug</code>-Methode
111 111 
          "<code class="function">message</code>" nimmt als ersten Paramter außerdem

Auch abrufbar als: Unified diff