Стиль кода

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

Совет

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.

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

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

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

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

  • 80 для Javadocs

  • 150 для кода

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

• Отступ

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

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

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

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

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

• Импорты

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

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

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

    • java импорты

    • javax импорты

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

• Исключения

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

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

  • Qualify all field accesses with this

• Javadocs

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

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

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

• Конец файла

  • Each file should end with an empty line

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

• Используйте Дополнительно вместо возвращения 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 <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);
    }

}