Code Formatierung

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

You can use our code styles for Eclipse or IntelliJ IDEA to let your IDE format the code correctly for you. Visit Sponge Code Styles.

• 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

  • File headers must contain the license headers for the project. Use the updateLicenses Gradle task to add them automatically

• 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

• Ende der Datei

  • Each file should end with an empty line

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.

• API: Use java.util.Objects.requireNonNull for null checks and ifs for argument checking.

• Impl: Use Google Preconditions for null- and argument checking.

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 <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 org.spongepowered.example;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.inject.Inject;
import org.slf4j.Logger;

import java.util.Optional;
import java.util.Random;
import java.util.concurrent.ThreadLocalRandom;

import javax.annotation.Nullable;

/**
* An example class which generates a new ID based on a specified base string
* and a randomly generated integer.
*
* <p>There is a chance the integer purposely fails to generate, in which case
* you can choose to provide a backup integer.</p>
*/
public class Example {

    private static final long SEED = 4815162342L;

    @Inject
    private Logger logger;

    private final String base;
    private final Random random;

    public Example(String base) {
        checkNotNull(base, "The specified base string cannot be null!");
        this.base = base;
        this.random = ThreadLocalRandom.current();
        this.random.setSeed(SEED);
    }

    /**
    * Generates and returns an ID using the base string specified on creation
    * or the alternative string if specified as well as a randomly generated
    * integer, which purposely fails to generate around 50% of the time.
    *
    * <p>A {@link ThreadLocalRandom} is used to check if the integer should
    * be generated and generates the integer itself if so.</p>
    *
    * @param alternate An alternate base string which will be used if not null
    * @return The generated ID, if available
    */
    public Optional<String> generateId(@Nullable String alternate) {
        if (this.random.nextBoolean()) {
            return Optional.of(alternate == null ? this.base : alternate + " - " + this.random.nextInt());
        }

        return Optional.empty();
    }

    /**
    * Generates and returns an ID using the base string specified on creation,
    * using a randomly generated integer if it was generated successfully, or
    * using the backup integer you specify.
    *
    * <p>A {@link ThreadLocalRandom} is used to check if the integer should
    * be generated and generates the integer itself if so. If it was not
    * generated, that is when your backup integer will be used.</p>
    *
    * @param backup A backup integer to use to create the ID with
    * @return The generated ID using the generated integer or the ID created
    *     using the backup integer specified
    */
    public String generateId(int backup) {
        return generateId(null).orElse(this.base + " - " + backup);
    }

}