Stijl van de code

Waarschuwing

This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.

Wij volgen Google’s Java Style Guidelines met een paar extra’s en aanpassingen, die hierin beschreven staan.

Tip

Je kan onze code conventies van Eclipse of IntelliJ IDEA gebruiken om je code automatisch correct te laten formatteren. Zie Voorberedingen voor Ontwikkeling voor meer informatie.

• Regeleindes

  • Gebruik het ‘einde lijn’ symbool uit Unix (\n) wanneer je een verandering verstuurt

    • Windows gebruikers van Git kunnen het commando git config --global core.autocrlf true gebruiken om Git ze automatisch te laten converteren

• Kolombreedte

  • 80 voor Javadocs

  • 150 voor code

  • Voel je vrij om te wrappen als het helpt om makkelijker te lezen

• Inspringing

  • Gebruik 4 spaties voor het inspringen van code, niet 2

• Verticale witregel

  • Plaats witregel voor het eerste onderdeel van een class, interface, enum, etc. (bijv. na class Example { moet eerst een witregel) dit moet ook na het laatste onderdeel

• Koppen van bestand

  • Koppen van een bestand moeten de licentie kop van het project bevatten. Gebruik de licenseFormat Grandle taak om die automatisch toe te voegen.

• Imports

  • Imports moeten gegroepeerd worden in de volgende volgorde, waar elke groep gescheiden wordt door een witregel

    • Statische imports

    • Alle andere imports

    • java imports

    • javax imports

  • Dit verschilt van de stijl van Google waar imports niet gegroepeerd worden door hun hoogste niveau package, ze zijn allemaal bij elkaar gegroepeerd.

• Uitzonderingen

  • Voor exceptions die genegeerd moeten worden, geef de exceptie variabele de naam ignored

• Veld toegangen

  • Kwalificeer alle veld toegangen met this

• Javadocs

  • Gebruik @author niet

  • Wrap extra paragrafen in <p> en``</p>``

  • Maak de eerste letter in de omschrijvingen een hoofdletter binnen elke “at clause”, bijvoorbeeld @param name Player to affect, zonder punten

Code conventies

• Gebruik Optionals in plaats van null terug te gegeven in de API

• Methode parameters die null accepteren moeten de annotatie @Nullable (van javax.*) krijgen. Alle methoden en parameters zijn standaard @Nonnull.

• Gebruik Google Preconditions <https://code.google.com/p/guava-libraries/wiki/PreconditionsExplained> voor het controleren van null en argumenten.

De Gist

Hoewel we graag zien dat u de Java conventies van Google leest, is het begrijpelijk om het over te slaan; het zijn immers twee lange documenten. Om je toch een opzetje te geven, hebben we hier een stukje correct geformatteerde code voor je:

/*
 * 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);
    }

}