Kod Stili

Uyarı

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.

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

Kod biçimleri Eclipse veya IntelliJ IDEA için IDE’nin doğru bir şekilde biçimlendirmesine izin verebilirsiniz. Daha fazla bilgi için :doc: ../../ prepared/index.

• 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ı

  • Dosya başlıkları, proje için lisans başlıkları içermelidir. Onları otomatik olarak eklemek için `` licenseFormat`` Gradle görevini kullanın.

• İç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

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.

• Boşluk ve bağımsız değişken denetimi için Önceden Hazırlanmış Google Koşulları’nı <https://github.com/google/guava/wiki/PreconditionsExplained> _ kullanın.

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

}