Style de Code

Nous suivons les Lignes directrices de Style Java de Google avec quelques ajouts et modifications, qui sont décrites dans les présentes.

Astuce

Vous pouvez utiliser nos styles de code pour Eclipse ou IntelliJ IDEA pour laisser votre IDE formater le code correctement pour vous. Visitez Sponge Code Styles.

• Fins de Ligne

  • Utilisez les fins de ligne Unix lors de votre commit (\n)

    • Les utilisateurs Windows de Git peuvent faire git config --global core.autocrlf true pour laisser Git convertir automatiquement

• Largeur de la Colonne

  • 80 pour les javadocs

  • 150 pour le code

  • Vous êtes libre de wrap si c’est bénéfique à la lisibilité

• L’indentation

  • Utilisez 4 espaces pour les indentations, n’utilisez pas 2 espaces

• Marge Verticale

  • Placez une ligne blanche avant le premier membre d’une classe, d’une interface, d’une enum, etc. (ex. après class Example {) aussi bien qu’après le dernier membre

• En-têtes de Fichiers

  • Les en-têtes de fichiers doivent contenir les licences d’en-têtes pour leur projet. Utilisez la tâche Gradle updateLicenses pour les ajouter automatiquement

• Imports

  • Les imports doivent être groupés dans l’ordre suivant, où chaque groupe est séparé par une ligne vide

    • Les Imports Statiques

    • Tous les Autres Imports

    • Les Imports java

    • Les Imports javax

  • Cela diffère du style de Google car les imports ne sont pas groupés par package de haut-niveau mais tous en un.

• Exceptions

  • Pour les exceptions qui doivent être ignorées, nommez la variable d’exception ignored

• Accès aux variables

  • Qualifiez tous les accès aux variables avec this

• Javadocs

  • N’utilisez pas @author

  • Entourez les paragraphes additionnels entre <p> et </p>

  • La première lettre des descriptions doit être une majuscule dans chaque « at clause », ex.: @param name Player to affect, sans point final

• Fin du fichier

  • Chaque fichier doit finir par une ligne vide

Conventions de Code

• Utilisez Optionnels à la place de retourner null dans l’API

• Les paramètres de méthodes acceptant une valeur null doivent être annotées avec @Nullable (de javax.*), toutes les méthodes et paramètres sont @Nonnull par défaut.

• Utilisez les Préconditions de Google pour la vérification des null et des arguments.

Le Gist

Bien que nous vous encourageons à lire les conventions Java de Google en particulier, les deux sont des documents assez longs. Afin de commencer rapidement, voici un exemple de code proprement formaté:

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

}