Стиль кода

Предупреждение

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.

Мы придерживаемся Google’s Java Style Guidelines с несколькими добавлениями и изменениями, которые описаны здесь.

Совет

Вы можете использовать наш стиль кода в Eclipse или IntelliJ IDEA для корректировки Вашего кода в удобной для Вас IDE. Смотрите Подготовка к разработке для получения дополнительной информации.

  • Перевод строки

    • Используйте Unix-формат окончания строк в коммитах (\n)

      • пользователи Windows могут написать команду git config --global core.autocrlf true для того, чтобы Git автоматически преобразовывал их

  • Ширина колонки

    • 80 для Javadocs

    • 150 для кода

    • Изменяйте так, как хотите, если это улучшит читабельность

  • Отступ

    • Используйте 4 пробела для отступа, не используйте 2 пробела

  • Вертикальный отступ

    • Вставляйте пустую строку перед первым и после последнего члена класса, интерфейса, перечисления (enum) и т.д. (т.е. после class Example { и перед })

  • Заголовки файла

    • Заголовки файлов должны содержать заголовки лицензии проекта. Используйте задачу Gradle licenseFormat, чтобы добавить их автоматически.

  • Импорты

    • Импорт должны быть сгруппированы в определенном порядке, где каждая группа отделена пустой строкой

      • Статические импорты

      • Все остальные импорты

      • java импорты

      • javax импорты

    • Это отличается от стиля Google, в котором импорты не группируются по родительскому пакету, они все группируются как один.

  • Исключения

    • Имя переменной исключения в игнорируемых исключениях должно быть ignored

  • Обращение к полям

    • Qualify all field accesses with this

  • Javadocs

    • Не используйте @author

    • Поместите дополнительные параграфы в <p> и </p>

    • Первая буква в описании должна быть заглавной, например, @param name Player to affect

Конвертирование кода

  • Используйте Дополнительно вместо возвращения null в API

  • Аргументы в методах, которые могут принимать значение null, должны быть с аннотацией @Nullable (из javax.*). Все методы и аргументы по умолчанию @Nonnull.

  • Use Google Preconditions for null- and argument checking.

Заключение

Хотя мы и призываем прочитать соглашения о Java-программировании от Google, эти два документа довольно объемны. Если же вы хотите побыстрее приступить к делу — вот пример правильно оформленного кода:

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

}