Code Formatierung

Warnung

Dieses Dokument bezieht sich auf eine veralte SpongeAPI-Version und wird nicht länger aktiv gepflegt. Während die Code-Beispiele für diese API-Version immer noch funktionieren, die Richtlinien und einige Links haben sich möglicherweise geändert. Bitte gehe stattdessen zur aktuellen Version der Dokumentation.

Wir folgen den „Google’s Java Formatierungs Richtlinien <https://google.github.io/styleguide/javaguide.html>“ wobei wir ein paar Änderungen und Erweiterungen haben, die in diesem Artikel beschrieben werden.

Tipp

Du kannst unsere Code Formatierungsvorlagen für Eclipse oder IntelliJ IDEA benutzen, um den Code durch deine Entwicklungsumgebung(IDE) korrekt formatieren zu lassen. Unter Vorbereitung für die Entwicklung findest du weitere Informationen.

• Zeilenenden

  • Benutze Unix Zeilenenden beim Committen (\n)

    • Auf Windows ist es durch das Ausführen des Git Befehls git config --global core.autocrlf true möglich, dies automatisch von Git konvertieren zu lassen

• Spaltenbreite

  • 80 für Javadocs

  • 150 für Quellcode

  • Du kannst auch mehr Zeilenumbrüche einbauen, wenn diese die Lesbarkeit verbessern

• Einrückung

  • Verwende 4 und nicht 2 Leerzeichen zum Einrücken

• Leerzeilen

  • Erstelle eine Leerzeile vor dem ersten und nach dem letzten Eintrag einer Klasse, Interface, Enum, usw. (in der Regel nach class Example {)

• Kopfzeilen

  • Die Kopfzeilen müssen den Lizenztext des Projektes enthalten. Verwende den Gradle Befehl licenseFormat um dies automatisch durchführen zu lassen.

• Imports

  • Imports müssen in der folgenden Reihenfolge gruppiert werden, wobei die Gruppen durch eine Leerzeile getrennt werden

    • Statische Imports

    • Alle anderen Imports

    • java Imports

    • javax Imports

  • Dies unterscheidet sich von Googles Stil, bei dem die Imports nicht nach der obersten Gruppe, sondern alle zusammen gruppiert werden.

• Exceptions

  • Wenn „Exceptions“ ignoriert werden sollen, muss die Exception Variable ignored genannt werden

• Zugriff auf Felder

  • Qualifiziere alle Feldzugriffe mit this

• Javadocs

  • Verwende kein @author

  • Umklammere zusätzliche Paragraphen mit <p> und </p>

  • Schreibe das erste Zeichen in jeder Beschreibung nach der Regel @param name Player to affect groß. Verwende keine Punkte

Code Konventionen

• Verwende, in der API, Optionals anstatt null als Rückgabewert

• Methoden die null akzeptieren müssen mit @Nullable ( javax.*) annotiert werden. Alle Methoden und Parameter sind standardmäßig @Nunnull.

• Verwende Google Preconditions für die Argument und „null“-Prüfung.

Ein Beispiel

Wir empfehlen, dass du die Google Java Conventions gelesen hast, vor allem die zwei sehr langen Dokumente. Damit du aber schneller beginnen kannst, haben wir hier ein Beispiel für die Formatierung für dich:

/*
 * This file is part of Sponge, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered.org <https://www.spongepowered.org>
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.example.java;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Random;
import java.util.Optional;

public class Example {

    private static final Logger log = LoggerFactory.getLogger(Example.class);
    private static final Random random = new Random();
    private final String id = "test";

    /**
     * Returns an identifier approximately half of the time.
     *
     * <p>A static instance of {@link Random} is used to calculate the
     * outcome with a 50% chance.</p>
     *
     * @return The ID, if available
     */
    public Optional<String> resolveId() {
        log.info("ID requested");

        if (random.nextBoolean()) {
            return Optional.of(this.id);
        } else {
            return Optional.empty();
        }
    }

    /**
     * Returns an identifier approximately half of the time.
     *
     * <p>A static instance of {@link Random} is used to calculate the
     * outcome with a 50% chance. If the outcome is to not return the ID,
     * the given fallback ID is returned.</p>
     *
     * @param fallback A fallback name to return
     * @return The ID half of the time, the given fallback the other half
     */
    public String resolveId(String fallback) {
        return resolveId().orElse(fallback);
    }

}