Programmierrichtlinien

Abschlussforum...
Verfügbare Informationen zu "Programmierrichtlinien"

  • Qualität des Beitrags: 0 Sterne
  • Beteiligte Poster: alex - Paul
  • Forum: Abschlussforum...
  • Forenbeschreibung: Forum zum Nicht-aus-den-Augen-verlieren
  • aus dem Unterforum: PPA Gruppe A Allgemein
  • Antworten: 3
  • Forum gestartet am: Mittwoch 11.04.2007
  • Sprache: deutsch
  • Link zum Originaltopic: Programmierrichtlinien
  • Letzte Antwort: vor 14 Jahren, 7 Monaten, 13 Tagen, 8 Stunden, 28 Minuten
  • Alle Beiträge und Antworten zu "Programmierrichtlinien"

    Re: Programmierrichtlinien

    alex - 24.04.2007, 20:56

    Programmierrichtlinien
    Benennungen
    Hier ein paar Programmierrichtlinien, die eingehalten werden sollten, damit der Code von uns einheitlich ist und jeder versteht, was der andere meint.

    Klassennamen in PascalCasing, also erste Buchstabe groß und dann jedes Wort des Klassennamens groß
    Code: //richtig:
    MyPerfectClass
    //falsch:
    myperfectclass


    Methodennamen und Variablen in camelCasing, also erster Buchstabe groß und dann jedes Wort des Bezeichners groß
    Code: // richtig:
    someMethod();
    // falsch:
    Do_something();

    - Unterstriche in Klassen, Methoden und Variablen nach möglichkeit vermeiden

    - Klassennamen und Methodennamen in Englisch

    - Getter und Setter-Methoden mit "get" und "set" am Anfang
    Beispiel:
    Code: getName();
    setName();


    - Klassennamen sollten Substantive sein
    - Methoden sollten Verben sein und aufzeigen was sie machen
    - Lesbarkeit des Codes sollte vor Kürze des Codes gestellt werden, jedoch sollten keine ultralangen unnützen Namen verwendet werden (schlechtes Beispiel: MyUltraImportantNewClass)


    Kommentare
    - Kommentare im JavaDoc-Style
    - über jeder Methode steht drin, was sie macht
    - wichtige dinge in einer Methode ebenfalls kommentieren

    - wichtige parameter sollten einzeln beschrieben werden
    Beispiel
    Code: /**
     * Beschreibung einer Methode
     *
     * @param importantParam Beschreibung des wichtigen Parameters
     */

    - Mehrzeilige Kommentare in der folgenden Form einfügen:
    Code: /**
     * Ein Kommentar
     * über mehrere Zeilen
     */

    - einzeilige Kommentare wie folgt einfügen:
    Code: // ein Kommentar

    Einrückungen
    Es wird mit Tab eingerückt. Das hat den Vorteil, dass jeder seinen Editor so einstellen kann, wie er es am angenehmsten hat
    Standardßig sollte ein tab aus 4 Leerzeichen bestehen



    Re: Programmierrichtlinien

    alex - 24.04.2007, 21:14


    falls euch irgendetwas nicht gefällt bzw. eine bessere Lösung habt, dann einfach antworten.



    Re: Programmierrichtlinien

    Paul - 25.04.2007, 08:44


    :mrgreen: Bin zu 100% einverstanden. Das mit den mehrzeiligen Kommentaren im Quellcode muss ich mir angewöhnen.

    Ach doch ein Vorschlag. Mehrzeilige normale Kommentare, die keine Javadoc darstellen sollen (also keine Klassen oder Methoden beschreiben), sollten wir in folgender Form darstellen:

    /*
    *
    *
    *
    */

    Das kann Eclipse auch automatisch. :)



    Mit folgendem Code, können Sie den Beitrag ganz bequem auf ihrer Homepage verlinken



    Weitere Beiträge aus dem Forum Abschlussforum...

    Habe aufgeräumt - gepostet von Paul am Donnerstag 09.08.2007
    Treffen 05 - 02.05.2007 - gepostet von Paul am Mittwoch 02.05.2007



    Ähnliche Beiträge wie "Programmierrichtlinien"