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 in einheitlicher, teils vorgegebener Sprache, kann sichergestellt werden, dass alle in dem Projekt involvierten Personen in der Lage sind, die Kommentare zu lesen und verstehen. Für Kommentare und Ein-/Ausgabe gibt es verschiedene Regelungen:

JavaDoc und Kommentare

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

Ein-/Ausgabe

Auch für die Ein-/Ausgabe soll auch eine einheitliche Sprache gewählt werden. Meißtens ist diese durch die Aufgabenstellung oder eine Vorlage schon vorgegeben. Hier ist es dann nicht möglich sich eine andere Sprache auszusuchen.

Randnotiz

Die Ausgabe und JavaDoc/Kommentare dürfen in unterschiedlicher Sprache verfasst werden. Sprich: Deutsche Kommentare mit englischer Ausgabe sind okay, sofern die Aufgabenstellung keine deutsche Ausgabe verlangt. Auch ist zu beachten, dass sich diese Regel wirklich nur auf Kommentare und JavaDoc bezieht. Quellcode und demnach auch Bezeichner sollen nachwievor auf Englisch verfasst werden (siehe Schlechte Bezeichner).

Negativbeispiel

/**
 * Prints the status of the player to the console.
 * @param player 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");
    }
}

Positivbeispiel

/**
 * Prints the status of the player to the console.
 * @param player 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");
    }
}