Stijl van de code

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

Tip

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.

• 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

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

• 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

• End of file

  • Each file should end with an empty line

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.

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

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

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

}