PROGRAMMIERSTIL

Question 1

Kommentare

Answer 1

Diese werden direkt in den Quelltext geschrieben und erklären den Sinn und Zweck von Code.

Question 2

Wie Kommentar (bis zum Zeilenende) in Java?

Answer 2

//

Question 3

Geklammerter Kommentar

Answer 3

/* Hier den Kommentar einfügen …
… usw. */

Question 4

Javadoc

Answer 4

Programm, das automatisch eine Dokumentation aus speziell kommentiertem Quellcode erstellt

Question 5

@param

Answer 5

wird für die Beschreibung eines Methoden-Parameters verwendet. Für jeden Parameter wird ein eigenes @param-Schlüsselwort verwendet.

Question 6

@return

Answer 6

wird verwendet, um zu beschreiben, was die Methode unter welchen Umständen zurückgibt.

Question 7

@throws

Answer 7

führt mögliche Fehlerquellen auf und die Exceptions, die dabei geworfen werden. Pro möglicher Exceptions wird ein @throws verwendet.

Question 8

@author
@version

Answer 8

Tags für Autor und Version in Java Docs

Question 9

Meta-Informationen

Answer 9

Dabei handelt es sich um zusätzliche Details zum Quellcode, die Aussagen über den Code machen.

Question 10

Annotationen

Answer 10

Dabei handelt es sich um Meta-Informationen zum Quellcode, die vom Java- Compiler und zur Laufzeit programmatisch ausgewertet werden können.

Question 11

@Override

Answer 11

Mittels @Override kennzeichnet man Methoden, die überschrieben wurden. Der Compiler bricht mit einem Fehler ab, falls die so annotierte Methode keine andere Methode überschreibt.

Question 12

@Deprecated

Answer 12

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.

Question 13

Wie beginnen Annotationen immer?

Answer 13

Mit einem @ gefolgt von einem Großbuchstaben.

Question 14

Code-Konventionen

Answer 14

Dabei handelt es sich um allgemeine Regeln, an denen man sich beim Schreiben von Quellcode orientiert.

Question 15

Camel-Case

Answer 15

Dies ist eine Schreibweise von zusammengesetzten Wörtern. Einzelne Bestandteile des zusammengesetzten Wortes werden mit großem Anfangsbuchstaben geschrieben und aneinandergereiht.

Question 16

Konventionen zur Benennung von Code (Beispiele)

Answer 16

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.

Question 17

Reihenfolgekonvention bei der Angabe von Klassenelementen

Answer 17

Question 18

Code-Block

Answer 18

Dieser beginnt mit einer öffnenden geschweiften Klammer und endet mit einer schließenden. Er umschließt Anweisungen im Quellcode.

Question 19

Einrückungskonvention bei der Formatierung von Code-Blöcken

Answer 19

Question 20

Konventionen für Code Blöcke

Answer 20

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.

Question 21

Konventionen bei der Setzung von Leerzeilen und -zeichen

Answer 21