Kod Stili

Burada açıklanan bazı ekleme ve değişiklikler için Google’ın Java yönergelerini (https://google.github.io/styleguide/javaguide.html> _ _) takip ediyoruz.

Tüyo

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.

• Satır sonları

  • Unix satır sonlarında (\n) kullanın

    • Windows kullanıcıları Git’i otomatik olarak dönüştürmelerini sağlamak için `` git config –global core.autocrlf true`` yapabilir

• Sütun genişliği

  • Javadocs için 80

  • kod için 150

  • Okunabilirlik olması için tamamlamaya çekinmeyin

• Girdi

  • Girdiler için 4 boşluk kullanın, 2 boşluk kullanmayın

• Dikey boşluk

  • Bir sınıfın, arayüzün, numaralandırıcının vb. İlk üyeden önce boş bir satır bırakın ( yani sınıf örneği {) ve ardından son üyeden sonra boş bir satır yerleştirin

• Dosya başlıkları

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

• İçe aktarılan

  • İçe aktarmalar aşağıdaki sıraya göre gruplandırılmalıdır; burada her grup boş bir satırla ayrılmıştır

    • Statik içe aktarmalar

    • Tüm içe aktarmalar

    • java içe aktarmalar

    • javax içe aktarmalar

  • Bu, içe aktarmaların üst düzey pakete göre gruplandırılmaması, hepsinin birer grup halinde gruplandırılması bakımından Google’ın tarzından farklıdır.

• İstisnalar

  • Yoksayılması gereken istisnalar için, ``ignored``değişkene isim verin

• Erişimler

  • ** all ** alan erişimlerini this ile nitelendirin

• Javadocs

  • ‘’ @author’’ kullanmayın

  • Paragraflarda <p> ve </p> kullanın

  • Her “cümle içi” açıklamalarında ilk harfi büyük harf yapar, yani `` @param adı Varsayılan kelime``, periyot yok

• End of file

  • Each file should end with an empty line

Kod Kuralları

• API da `` null`` yerine İsteğe bağlı kullanın

• null parametrelerinde `` @ Nullable`` (javax. * için), tüm yöntemler ve parametreler varsayılan olarak `` @ Nonnull`` olarak açıklanmalıdır.

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

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

Özü

Google’ın Java sözleşmelerini biraz uzun belgeler olsalar da özellikle okumanızı tavsiye edilir. Hemen başlamak için doğru biçimde biçimlendirilmiş bir kod örneği aşağıda verilmektedir:

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

}