Richtlinien für guten Code

Warum sollte man guten Code schreiben?

  • Man kann einfacher Fehler finden.
  • Man vermeidet durch bessere Übersichtlichkeit Fehler.
  • Andere können sich besser in den Code hineindenken.
  • Man kann auch nach Wochen der Abstinenz sein Projekt mit möglichst wenig Aufwand weiterführen.

Was führt zu gutem Code?

Richtlinien für den Code

  • Jede geschweifte Klammer-Auf befindet sich am Ende einer Zeile.
  • Jede geschweifte Klammer-Zu befindet sich alleine in einer Zeile und ist genauso weit eingerückt, wie die Zeile, in der sich die zugehörige Klammer-Auf befindet.
  • Alles zwischen zwei geschweiften Klammern wird um einen Tab nach rechts eingrückt.
  • Wenn man alles richtig gemacht hat, sollte am Ende jeder Zeile entweder eine geschweifte Klammer oder ein Semikolon stehen

Noch mehr Richtlinien für guten Code

  • Alle wichtigen Dinge sollten im Quelltext kommentiert werden:
    • Aufgabe / Nutzungshinweise von Methoden
    • Aufgabe / Inhalt von Variablen
    • Sinn von Klassen

Richtlinien für Bezeichner

  • Keine Umlaute oder sonstige Sonderzeichen. Nur Buchstaben und Ziffern.
  • Anhand des Namens muss man erkönnen können, welchen Inhalt die Variable / die Methode / das Objekt vertritt.
  • Handelt es sich um eine Komponente, soll der Name mit einem Kürzel beginnen. Beispiele:
    • Button zum Speichern: bSpeichern
    • Label für Namen: lName
    • Textfield für Ort: tfOrt
  • Besteht ein Bezeichner aus mehreren Worten, werden die Worte ohne zusätzliche Zeichen hintereinander gereiht. Dabei wird das erste Wort klein und die anderen groß geschrieben. Beispiele:
    • strasseBenutzerZuHause
    • telefonBenutzerArbeit
  • Nur Bezeichner für Klassen werden groß geschrieben
    • MeinErstesApplet
    • String
  • Konstanten (final) werden vollständig groß geschrieben:
    • final String MEINNAME = „Claudius“;
    • „final int MEINEHAUSNUMMER = 3;''
Cookies helfen bei der Bereitstellung von Inhalten. Durch die Nutzung dieser Seiten erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Rechner gespeichert werden. Weitere Information
Falls nicht anders bezeichnet, ist der Inhalt dieses Wikis unter der folgenden Lizenz veröffentlicht: CC Attribution-Noncommercial-Share Alike 4.0 International