PROGRAMMIERSTIL Flashcards
Kommentare
Diese werden direkt in den Quelltext geschrieben und erklären den Sinn und Zweck von Code.
Wie Kommentar (bis zum Zeilenende) in Java?
//
Geklammerter Kommentar
/* Hier den Kommentar einfügen …
… usw. */
Javadoc
Programm, das automatisch eine Dokumentation aus speziell kommentiertem Quellcode erstellt
@param
wird für die Beschreibung eines Methoden-Parameters verwendet. Für jeden Parameter wird ein eigenes @param-Schlüsselwort verwendet.
@return
wird verwendet, um zu beschreiben, was die Methode unter welchen Umständen zurückgibt.
@throws
führt mögliche Fehlerquellen auf und die Exceptions, die dabei geworfen werden. Pro möglicher Exceptions wird ein @throws verwendet.
@author
@version
Tags für Autor und Version in Java Docs
Meta-Informationen
Dabei handelt es sich um zusätzliche Details zum Quellcode, die Aussagen über den Code machen.
Annotationen
Dabei handelt es sich um Meta-Informationen zum Quellcode, die vom Java- Compiler und zur Laufzeit programmatisch ausgewertet werden können.
@Override
Mittels @Override kennzeichnet man Methoden, die überschrieben wurden. Der Compiler bricht mit einem Fehler ab, falls die so annotierte Methode keine andere Methode überschreibt.
@Deprecated
Mittels @Deprecated kennzeichnet man Klassen, Attribute und Methoden, die veraltet sind und in neuem Code nicht mehr verwendet werden sollen. Diese Annotation löst in Code, der diese Codeteile benutzt, eine Warnung aus.
Wie beginnen Annotationen immer?
Mit einem @ gefolgt von einem Großbuchstaben.
Code-Konventionen
Dabei handelt es sich um allgemeine Regeln, an denen man sich beim Schreiben von Quellcode orientiert.
Camel-Case
Dies ist eine Schreibweise von zusammengesetzten Wörtern. Einzelne Bestandteile des zusammengesetzten Wortes werden mit großem Anfangsbuchstaben geschrieben und aneinandergereiht.
Konventionen zur Benennung von Code (Beispiele)
1) Paketnamen werden stets klein geschrieben.
2) Klassen und Interfaces werden als Substantive benannt und stets mit einem großen Anfangsbuchstaben geschrieben. Besteht ein Klassenname aus mehreren Wörtern, so werden die einzelnen Wortanfänge ebenfalls großgeschrieben. Man spricht hier auch von Camel-Case, weil der zusammengesetzte Name durch die Groß- und Kleinschreibung „Buchstabenhöcker“ bekommt.
3) Klassenkonstanten werden komplett großgeschrieben und Wörter mit Unterstrich voneinander getrennt.
4) Methodennamen sind möglichst immer Verben. Sie werden mit kleinem Anfangsbuchstaben, aber sonst in Camel-Case geschrieben.
5) Attribute und Variablen sollen sinnvoll benannt sein, sodass sich aus dem Namen bereits eine Beschreibung des Inhaltes schließen lässt.
Reihenfolgekonvention bei der Angabe von Klassenelementen
Code-Block
Dieser beginnt mit einer öffnenden geschweiften Klammer und endet mit einer schließenden. Er umschließt Anweisungen im Quellcode.
Einrückungskonvention bei der Formatierung von Code-Blöcken
Konventionen für Code Blöcke
1) Benötigte Variablen sollten zu Beginn eines Block deklariert und gleichzeitig initialisiert werden.
2) Jede Deklaration wird in eine eigene Zeile geschrieben.
3) Absätze werden verwendet, um semantisch zusammenhängende Anweisungsabschnitte voneinander zu trennen.
4) Leerzeichen hingegen trennen semantische Einheiten innerhalb einer Codezeile. Das bedeutet, sie trennen die Operanden eines Ausdrucks, werden aber nicht zwischen den Methodenname und dessen Klammer oder das for, if oder while und dessen Klammer gesetzt.
Konventionen bei der Setzung von Leerzeilen und -zeichen
