Kode gaya

Peringatan

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.

Kami mengikuti Google Java Pedoman Gaya dengan beberapa penambahan dan modifikasi, yang dijelaskan di sini.

Tip

Anda dapat menggunakan pedoman gaya untuk Eclipse atau IntelliJ IDEA untuk membiarkan IDE anda format kode dengan benar untuk anda. Lihat ../../mempersiapkan/index untuk informasi lebih lanjut.

• Garis akhir

  • Gunakan akhir baris unix kapanpun melakukan (\n)

    • Pengguna Windows Git dapat melakukan git config --global inti.autocrlf benar untuk membiarkan Git mengkonversi mereka secara otomatis

• Lebar kolom

  • 80 untuk javadocs

  • 150 untuk kode

  • Jangan ragu untuk membungkusnya saat akan membantu keterbacaan

• Lekukan

  • Gunakan 4 ruang untuk lekukan, tidak gunakan 2 ruang ruang

• Vertikal spasi

  • Tempat baris kosong sebelum anggota pertama dari kelas, antarmuka, enum, dll. (yaitu setelah class Contoh {) serta setelah anggota terakhir

• File header

  • File header yang harus berisi lisensi header untuk proyek tersebut. Gunakan licenseFormat Gradle tugas untuk menambahkannya secara otomatis.

• Impor

  • Impor harus dikelompokkan dalam urutan berikut, dimana masing-masing kelompok dipisahkan oleh sebuah baris kosong

    • Impor statis

    • Semua impor lain

    • ' 'java' ' impor

    • ' 'javax' ' impor

  • Ini berbeda dengan gaya gougle karena impor tidak dikelompokkan menurut paket tingkat atas, semuanya dikelompokkan sebagai satu.

• Pengecualian

  • Untuk pengecualian yang harus diabaikan, beri nama variabel ' ' 'diabaikan' ' '

• Akses lapangan

  • Memenuhi syarat semia akses lapangan dengan ' 'ini' '

• Javadocs

  • Jangan gunakan @penulis

  • Bungkus tambahan paragraf di <p> dan </p>

  • Membesarkan huruf pertama dalam deskripsi dalam setiap "pada klausul", yaitu @param nama Pemain untuk mempengaruhi, tidak ada periode

Kode konvensi

• Penggunaan Pilihan bukannya kembali null dalam API

• Metode parameter menerima null harus dijelaskan dengan @Nullable (dari javax.*), semua metode dan parameter @bukan null secara default.

• Menggunakan Google Prasyarat null - dan argumen memeriksa.

Itu intinya

Meskipun kami mendesak agar anda membaca konvensi gougle di java khususnya, keduanya cukup panjang, untuk memulai dengan cepat, berikut adalah contoh kode yang diformat dengan benar:

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

}