OTRS CVS - Handbuch
Prev | Chapter 24. Entwicklerhandbuch | Next

# Programmierstil

Um eine einheitliche Entwicklung innerhalb des OTRS Projekts gewährleisten zu können, sind einige Rahmenbedingungen und Vorgaben bezüglich des Stils zu beachten.

1. Formatierung: Ein Tabulator erstreckt sich über 4 Leerzeichen. (----). Bitte beachten Sie auch die Position der Klammern. Hierzu zwei Beispiele:

     if ($Condition) {
         Foo();
     }
     else {
         Bar();
     }

und

     while ($Condition == 1) {
         Foo();
     }

2. Namensgebung: Die Namensgebung und die Kommentierung des Programmcodes erfolgen in englischer Sprache. Variablen, Objekte und Methoden werden durch Nomen oder durch aneinandersetzen von Nomen beschrieben. Achten Sie darauf, dass jedes Wort mit einem Großbuchstaben beginnt. (z. B.: '@TicketIDs' oder '$Output' oder 'BuildQueueView()')

3. Kopfzeile im Code: Fügen Sie die folgende Kopfzeile in jede Datei ein:

    # --
    # (file name) - a short decription what it does.
    # Copyright (C) (year) (name of author) (email of author)
    # --
    # $Id: developer-guide.sgml,v 1.2 2004/01/14 08:18:11 jens Exp $
    # --
    # This software comes with ABSOLUTELY NO WARRANTY. For details, see
    # the enclosed file COPYING for license information (GPL). If you
    # did not receive this file, see http://www.gnu.org/licenses/gpl.txt.

4. Sonstiges: All das, was sich auf http://www.perl.com/CPAN-local/doc/manual/html/pod/perlstyle.html bezieht.

Darüber hinaus können Sie 'pb' den 'Perl Beautifier' zur Verschönerung Ihres Programmcodes verwenden. (http://www.arachnoid.com/lutusp/ftp/cgi/pb.txt). Es ist sehr zu empfehlen.

Prev | Home | Next
Entwicklerhandbuch | Up | Fehlerbeseitigung