Estilo de Código

Seguimos las Directrices de Estilo de Java de Google <https://google.github.io/styleguide/javaguide.html>`_ con unas pocas adiciones y modificaciones, aquí descritas.

Truco

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.

• Finales de línea

  • Use finales de línea de Unix al asignar (\n)

    • Los usuarios de Windows de Git pueden ejecutar ``git config –global core.autocrlf true` para permitirle a Git convertirlos automáticamente

• Ancho de columna

  • 80 para documentos de Java

  • 150 para código

  • Jangan ragu untuk membungkusnya saat akan membantu keterbacaan

• Sangría

  • Usa 4 espacios para las sangrías, no uses 2 espacios

• Espacio en blanco vertical

  • Deja una linea en blanco antes del primer miembro de una clase, interfaz, enumeración, etc. (es decir después de``class Ejemplo {``) al igual que después del ultimo miembro

• Cabeceras de fichero

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

• Importaciones

  • Las importaciones deben estar agrupadas en el siguiente orden, donde cada grupo es separado por una linea en blanco

    • Importaciones estaticas

    • Todas las otras importaciones

    • Importaciones java

    • Importaciones javax

  • Esto difiere del estilo de Google en que las importaciones no son agrupadas por paquetes de primer nivel, son todas agrupadas como una.

• Excepciones

  • Para excepciones que deben ser ignoradas, nombra la variable de excepción ignored

• Accesos de campo

  • Califica todos los campos de acceso con this

• Javadocs

  • No uses @author

  • Pon los parrafos adicionales entre las etiquetas <p> y </p>

  • Ponga en mayúscula la primera letra en las descripciones dentro de cada «at clause», p.ej @param name Player to affect, sin puntos

• End of file

  • Each file should end with an empty line

Convenciones de Código

• Usa Opcionales en lugar de devolver null en la API

• Los parámetros de los métodos que admitan null deben ser anotados con @Nullable (from javax.*), todos los métodos y parámetros son @Nonnull por defecto.

• Usa Google Preconditions para nulo - y comprobación de argumentos.

La Razón

Aunque insistimos particularmente en que leas las convenciones de Google sobre Java, ambos son documentos bastante largos. Para que empieces rápidamente, aquí tienes un ejemplo de un código correctamente formateado:

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

}