Kode gaya

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

Tip

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.

• 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 headers must contain the license headers for the project. Use the updateLicenses Gradle task to add them automatically

• 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

• End of file

  • Each file should end with an empty line

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.

• API: Use java.util.Objects.requireNonNull for null checks and ifs for argument checking.

• Impl: Use Google Preconditions for null- and argument checking.

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

}