Einheitliche Sprache

🚧

Diese Seite befindet sich in Bearbeitung

🚧

🤓

Diese Seite ist eine Bewertungsrichtlinie, die ab Blatt 1 annotiert und ab Blatt 1 abgezogen wird.

🤓

Beschreibung

Es kann sehr anstrengend für eine Person werden, die den Quellcode verstehen möchte, Kommentare in unterschiedlichen Sprachen zu lesen. Auch gibt es das Problem der Sprachbarriere. Kommentare in einer unbekannten Sprache sind demnach unverständlich und nicht hilfreich. Sind Kommentare aber in einheitlicher, teils vorgegebener Sprache formuliert, kann sichergestellt werden, dass alle in dem Projekt involvierten Personen die Kommentare lesen und verstehen können. Für JavaDoc/Kommentare und Ein-/Ausgabe gibt es verschiedene Regelungen:

JavaDoc und Kommentare

JavaDoc und Entwicklerkommentare sollen in diesem Übungsbetrieb auf Deutsch oder Englisch verfasst werden. Die Sprache soll hierbei über das gesamte Projekt einheitlich sein. Auch zwischen verschiedenen Kommentartypen. Welche dieser Sprachen das ist, darf selbst ausgesucht werden.

Ein-/Ausgabe

Auch für die Ein-/Ausgabe soll eine einheitliche Sprache gewählt werden. Für Ausgaben ist zu beachten, dass diese, wie andere String-Literale auch, als Programmcode zählen und demnach auf Englisch verfasst werden sollten. Es kann allerdings Aufgaben geben, in denen eine deutsche Ausgabe gefordert wird. In diesem Fall sind die Ausgaben auf Deutsch zu verfassen.

Randnotiz

Die Ausgabe und JavaDoc/Kommentare dürfen in unterschiedlicher Sprache verfasst werden. Sprich: Deutsche Kommentare mit englischer Ausgabe sind in Ordnung, sofern die Aufgabenstellung keine deutsche Ausgabe vorgiebt. Auch ist zu beachten, dass sich diese Regel ausschließlich auf Kommentare und JavaDoc bezieht. Quellcode und demnach auch Bezeichner sollen nach wie vor auf Englisch verfasst werden (siehe Schlechter Bezeichner).

Negativbeispiel:

Für dieses Beispiel ist eine englische Ausgabe vorgegeben.

/**
 * Prints the status of the player to the console.
 * @param playerId The id of the player
 */
public void printPlayerStatus(int playerId) {
    // Falls der Spieler unbekannt ist, wird null zurückgegeben
    Player player = findPlayerById(playerId);

    if (player == null) {
        System.out.println("Error, unbekannter Spieler");
    } else {
        System.out.println("Player"  + playerId + " has " + player.getHP() + "HP");
    }
}

Hier wurden zwischen JavaDoc und Kommentar fälschlicherweise unterschiedliche Sprachen verwendet.

Außerdem ist die Ausgabe im Falle von player == null auf Deutsch, obwohl eine englische Ausgabe vorgegeben wurde.

Positivbeispiel:

/**
 * Prints the status of the player to the console.
 * @param playerId The id of the player
 */
public void printPlayerStatus(int playerId) {
    // Returns null if the player is unknown
    Player player = findPlayerById(playerId);

    if (player == null) {
        System.out.println("Error, unknown player");
    } else {
        System.out.println("Player"  + playerId + ": " + player.getHP() + "HP");
    }
}

Hier haben JavaDoc und Kommentar dieselbe Sprache. Der Kommentar wurde der Sprache des JavaDocs angepasst; alternativ hätte man das JavaDoc dem Kommentar anpassen können.

Auch wurde die Sprache bei der Ausgabe des Fehlers angepasst, wie es von der Aufgabe vorgegeben wurde.