Style de Code

Avertissement

Cette documentation est faire pour une ancienne version de SpongeAPI et n’est plus maintenue. Même si les examples de code fonctionnent toujours pour cette version de l’API, les politiques, lignes de conduite, et quelques liens peuvent avoir changé. Veuillez vous rendre sur la dernière version de la documentation pour ces derniers.

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 notre Style de Code pour Eclipse ou IntelliJ IDEA pour laisser votre IDE formater le code correctement pour vous. Voir Préparation pour le développement pour plus d’informations.

• 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 licenseFormat 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

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 de null- et d’argument.

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

}