Java Yazım Kuralları ve Önerileri

​Her dilin olduğu gibi programlama dillerinin de kendi içinde belli kuralları var. Bu kurallara uyarak yorumlayıcıya veya derleyiciye kodunuzu doğru biçimde ifade edebilirsiniz. Öncelikle neden ihtiyacımız olduğuna değinelim: (Kaynak: Oracle Code Conventions)

• Yazılım üretimindeki %80'lik zaman dilimi, kod bakımına (maintenance) harcanıyor.
• Çok az yazılım, yaşamı boyunca ilk yazarınca geliştirilir.
• Kod yazma gelenekleri yazılımın okunmasını ve anlaşılmasını kolaylaştırır.
• Mühendislerin yeni kodu hızlı ve verimli bir şekilde anlamasını sağlar.
• Kodunuzu açmaya karar verdiğinizde daha anlaşılır olacağı için daha kolay destek bulursunuz.

Android için Java kodu yazarken bu belgede önerilen bazı kurallara mutlaka uymanız gerekiyor. Bunun yanında geleneksel olarak kabul görmüş bazı önerileri de burada bulabilirsiniz.

• Değişken tanımlama kuralları ve önerileri
• Fonksiyon tanımlama kuralları ve önerileri
• Sınıf tanımlama kuralları ve önerileri
• Yorum satırı önerileri

 

Değişken tanımlama kuralları ve önerileri

Kural: Bir değişken yazarken önce onun tipini, sonra adını yazmalısınız:

Öneri: Değişken ismi yazmanın belli kuralları var. Örneğin CamelCase kuralıyla isimlendirme yaparken isimlerin ilk harfi büyük olmalı. Eğer değişken ismi iki kelimeden oluşuyorsa ikinci kelimenin de ilk harfi büyük olmalı. Örn:

Integer UyeSayisi

 

Öneri: Geleceği Yazanlar'da genellikle Mixed Case olarak isimlendirilen, ilk harfinin küçük olması dışında CamelCase'e benzeyen yaklaşımı tercih ediyoruz. (Çünkü CamelCase, çoğunlukla sınıf isimlendirmelerinde kullanılır) Örn:

Integer uyeSayisi

 

 

Kural: Değişken isimlerinde Türkçe karakter kullanamazsınız.

Kural: Değişken adları rezerve edilmiş Java sözcüklerinden oluşamaz (int, float, public, static, volatile vs). Bu sözcükler Java derleyicisinde bir anlam ifade ettiğinden değişken adı olarak kullanılamazlar.

Kural: Değişken isimleri rakamla başlayamaz ancak içinde rakam olabilir. Örn:

 

Integer dogrulamaKodu2;

 

 

Öneri: Sabit-değeri değişmeyen değişkenleri büyük harfle ve kelime aralarına alt çizgi koyarak yazınız. Örn:

public static final Integer VARSYLN_CARPISMA_KATSAYISI;

 

Öneri: Java'da uygulamalar sınıflar halinde yazılır. Ayrıntılarını ilerleyen bölümlerde göreceksiniz. Bir sınıfın üyesi olacak değişken tanımlayacağınız zaman onun isminin önüne m getirebilirsiniz. Böylelikle kodunuzu okuyan kişi, bu değişken ismini nerede görürse görsün, sınıfın üyesi (member) olduğunu anlayacaktır. Örn:

public class ProfileTask {

    private Integer mArkadasSayisi;

}

Öneri: Bazı sınıf değişkenleri static olarak tanımlanırlar. Böyle değişkenlerin adının önüne s ön eki getirebilirsiniz. Bu da onun diğer değişkenlerden ayrılmasını kolaylaştırılacaktır. Örn:

public class ProfileTask {

    private Integer mArkadasSayisi; 
    private static Integer sEtkinIslemSayisi;

}

 

Fonksiyon tanımlama kuralları ve önerileri

Kural: Bir fonksiyonun işini bitirdikten sonra döndüreceği değerin tipi fonksiyon adından önce yazılır. Örneğin:

public Integer getArkadasSayisi(){
        return mArkadasSayisi;
    }

Burada getArkadasSayisi() isimli fonksiyonun Integer türünden değer döndüreceğini anlıyoruz.

Öneri: Kendi oluşturduğunuz fonksiyonların isimlerini fonksiyonun görevini ifade edecek şekilde seçmelisiniz. sayi() yerine getDersSayisi() gibi.

 

Sınıf tanımlama kuralları ve önerileri

Kural: Sınıf ismiyle, o sınıfı sakladığınız dosyanın ismi aynı olmalıdır. Örneğin LoginManager sınıfı LoginManager.java dosyasında saklanmalı.

Kural: Sınıf isimleri verirken değişken tanımlarken uyguğunuz kurallara uymalısınız.

Öneri: Sınıfları isimlendirirken fiilleri kullanmak yerine özellikle isimler kullanmalısınız. Çünkü sınıflar gerçek hayattaki nesnelerin karşılığıdır. Örneğin User, UserManager birer isimdir. Register, Login, Delete gibi işlemler birer fiildir.

Öneri: Sınıf isimleri CamelCase biçiminde verilmelidir.

public class usermanager {...}

yerine

public class UserManager

kullanmak kodunuzu daha okunur kılacaktır.

 

Yorum satırı kuralları ve önerileri

Yazılan kodu ister siz ister başkası yazmış olsun, sonradan okuyan herkes için kodu anlatmanın en kolay yollarından biri ona yorumlar bırakmaktır. Java'da satıra ya da birçok satıra blok olarak yorum koyulabilir.

Kural: Java'da bir yorum satırı oluşturmak için satırın başına "//" (iki tane bölü işareti) getirmek yeterlidir. Birden fazla satırı aynı anda yorum satırı haline getirmek için tek tek hepsinin başına "//" koymak yerine en baştaki satıra "/*" ve en sondaki satırın sonuna da "*/" koymak yeterlidir. 

Örnek:

/*public Integer getArkadasSayisi(){
        return mArkadasSayisi;
    }*/
    ...
        
    public static Boolean isEtkinIslemSayisiBigger(Integer _islemSayisi) {
        if (_islemSayisi>sEtkinIslemSayisi) {
            return true;
        } else {
            //return false;
            return 0;
        }    
    }
    
    ...

Öneri: Bir sınıfı tanımlarken o sınıfın ne işe yaradığını hemen sınıf tanımlamasının üzerine yazabilirsiniz. Örneğin:

/*
* Kullanıcının ilk göreceği Activity sınıfıdır.
*
* Burada iki adet farklı giriş seçeneği sunulmaktadır. Bunlar
* LoginService ve SignupService isimli servislerle konuşur.
*
*/
public class MainActivity extends Activity {

   ...
}