コーディング規約

警告

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 で私たちのコードスタイルに沿ったフォーマットを使用するようにできます。詳しくは開発環境の準備を参照してください。

改行
- Unixの改行コード(\n) を使用します。
  - WindowsのGitユーザは git config --global core.autocrlf true で自動で変換するように設定できる
1行の文字数
- Javadocは80
- コードは150
- 可読性を向上させるためならば、自由に改行してよい
インデント
- インデントには2スペースではなく、4スペースを使用する
縦方向の空白
- クラス、インターフェース、列挙子など、初めに出てくるメンバの前 (例: class Example { の後ろ) と、最後のメンバの後ろには空行を入れる
ファイルヘッダ
- ファイルヘッダにはプロジェクトのライセンスヘッダを含まなくてはいけません。 Gradleタスクの licenseFormat で自動追加できます。
インポート
- インポートは以下の順に行い、それぞれのグループは空行で区切られる
  - 静的インポート
  - その他すべてのインポート
  - java imports
  - javax のインポート
- 最上位パッケージでインポートがグループ化されていないという点で、これは Google のスタイル異なります。彼らはすべてをまとめてグループ化します。
例外
- 例外を無視する場合は、例外の変数名を ignored にする
フィールドアクセス
- Qualify all field accesses with this
Javadocs
- @author を使用しない
- 段落は <p> と </p> で囲む
- 「1節」の最初の文字を大文字にし、ピリオドはつけない (例: @param name Player to affect)

コーディング規約

APIで null を返す代わりに、 Optional を使用する
メソッドのパラメータに null を許可する場合は(javax.* の) @Nullable アノテーションをつける必要がある。すべてのメソッドのパラメータはデフォルトで @NotNull アノテーションをつける。
null と引数チェックには Google Preconditions を使用します。

Gist

かなり長い文章が2つありますが、Google の Java 規約を読むことをお勧めします。すぐに開始するためには、以下の適切にフォーマットされた例を参照してください。

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

}