Estetyka kodu w programowaniu

Ostrzeżenie

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.

Wciąż prężnie podążamy za Google’s Java - Estetyka w kodzie z kilkoma dodatkami i zmianami, które są opisane w tym dokumencie.

Wskazówka

Możesz użyć ustawień stylu dla Eclipse lub Intellij IDEA, aby twoje IDE wiedziało jak poprawnie formatować źródło pisane przez Ciebie. Zobacz :doc: ../…/preparing/index aby dowiedzieć się więcej.

  • Line endings - Zakończenia linii

    • Używaj Unixowych zakończeń linii w commitach (\n)

      • Ci użytkownicy, którzy są skazani na Windowsa mogą wykonać komende git config --global core.autocrif true, aby GitHub konwertował je automatycznie.

  • Szerokości kolumn

    • 80 dla Javadocs

    • 150 dla kodu źródłowego

    • Zawijaj tekst wedle uznania jeśli to zwiększy jego czytelność

  • Intentation - Wcięcie, tabulacja

    • Użyj 4 razy spacja do wcięcia, nie używaj 2 spacji

  • Vertical whitespace - Odstępy w pionie

    • Pozostaw pustą linię przed pierwszym elementem klasy, interfejsu, itd. (np.: po class Example {) jak również po ostatnim elemencie

  • File headers - Nagłówki plików

    • Nagłówki plików muszą zawierać nagłówki licencyjne projektu. Użyj licenseFormat, aby dodać je automatycznie.

  • Imports - definiowanie ścieżek pakietów

    • Importy muszą być pogrupowane według podanej kolejności, gdzie każda grupa jest oddzielona pustą linią:

      • Static imports - Importy statyczne

      • All other imports - pozostałe importy

      • java imports

      • java imports

    • Jest to jedna z różnic od Google`s Style, w tym Importy nie są pogrupowane według najwyższego poziomu pakietu, ale są one zgrupowane w jednym.

  • Exceptions (wyjątki)

    • Dla wyjątków, które mają być ignorowane użyj ignored jako nazwy zmiennej wyjątku.

  • Field accesses - Pole dostępu

    • Kwalifikują się wszystkie pola dostępu z this

  • Javadocs - dokumentacja java

    • Nie używać @author

    • Wykorzystaj dodatkowe znaczniki <p> i </p>, aby oznaczyć paragrafy

    • W opisie każdej klauzuli rozpoczynaj opis wielką literą, bez kropek np.: @param name Player na którego działamy, żadnych kropek i przecinków

Zasady umowne programowania

W kierunku sedna sprawy - czyli o co mu chodzi?!

Podczas gdy namawiamy Ciebie, abyś przeczytał dokładnie Google Java conventions particularly, powstały dwa dość długie dokumenty. Zacznij szybko! Oto przykład poprawnie sformatowanego kodu:

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

}