Zafer Teker

tekzaf@yahoo.com

Java'da Kod Geleneği (Code Convention)

Her dilin bir kodlama geleneği vardır. Kodlarınızın bu geleneğe uyması kodunuza okunaklık sağlar. Java'da da kod geleneği vardır. Bu yazıda bu gelenek anlatılcaktır.

Java Kaynak Dosyaları

Kaynak kodlar .java uzantılı dosyalarda tutulurlar. Bu dosyada en az bir public class olmalıdır. Bir kaynak dosyasının akışı şu şekilde olmalıdır.

Yorum
Paket ve Import'lar
Class ve Interface'ler.

Bir class veya bir interface'nin akışı şu şekilde olmalı.

Yorum
Class ve Interface tanıtımı
Değişkenler
Kurucu
Method'lar

Örneğin

/** Bu class sadece bir örnektir. 
Her hakkı mahfuzdur ve iktibas edilemez.*/

package com.godoro.codeconvention;

import java.util.*;

public class Test{
	//değişkenler
	public String test="bu test";
	//kurucu
	public Test(){
		System.out.println("Kurucu");
	}
	//method'lar
	public void setTest(String test){
		this.test=test;
	}
}

Birden fazla değişkenlerde kendi aralarında şu şekilde sıralanırlar.

public 
protected
package level (tanımlayıcı yok)
private

ve final static değişkenler (Diğer dillerdeki constant gibi) en üste yazılırlar.

public final static PUBLIC_STATIC_TEST="public static test";
public String name;
protected String surname;
int a;
private int number;

Birden fazla method'un sıralamsında bir gelenek bulunmamaktadır. method'ların işlevine göre sıralanabilir. Aynı benzer görevleri yapan method'lar arka arkaya olabilirler. Değişkenler gibi sıralanabilir. Önce public, sonra protected ve en sona da private method'lar koyulabilir.

Kodun Görünümü-Yerleşimi

Bir satırın uzunluğunun 80 karakteri geçmemesi tavsiye edilir. Eğer kod satırı 80 karekteri geçiyorsa yeni satır karakteri yapılması gerekir. Genellikle virgülden sonra, oparatörler'den önce yeni satır yapılır. Eğer ( ) arasında bir grup varsa bu grup olduğu gibi aşağıya alınabilir.

public String a="dfsdfsdf"+"efsdfsdfsdfsd"+"dfsdfsfsdfsfs"
	+"asdadadf"+"dsfsdfsdf";
public static String getName(String aaaaa,String bbbbb,
	String cccc,String dddd){
}
if((aaaaaaa||bbbbbbbb) ||(daaaaaa||bbbbbbbb)||(faaaaaa||bbbbbbbb)
	||(kaaaaaa||bbbbbbbb)){
}

Deklarasyonlar

Tek satırlık deklarasyonlar şu şekilde yapılabilir.

int a="2"; // bu bir test sayısı

veya

int a,number,str;

şeklinde yan yana yazılabilir.

{} içindeki blok'lar her zaman bir tab içeride olmalıdırlar. Örneğin

public void test(){
	//bu bir tab içeride
	int a=b+c;
	if(a>b){
		//bu da bir tab içeride;
		c=a+b;
	}
}

Method deklarasyonlarında method adı ile () işaretleri arasına boşluk koymayın.

Bir dosyada birden fazla class veya interface varsa aralarına iki satır boşluk verin. Method'lar arasında bir boş satır yaratın.

İsimlendirme Geleneği

Paket İsimleri

Paket isimleri her zaman küçük harfler kullanılmalıdır. En üst paket her zaman bir domain adı olmalıdır. com,org gibi. Örnek olarak

com.godoro.tools;
com.godoro.linkchecker;
com.test.testclient

Class ve Interface İsimleri

Class ve interface isimlerinin ilk harfi her zaman büyük olmalıdır. İki ve daha fazla kelimden oluşuyorsa her kelimenin ilk harfi büyük harf olalıdır. Diğer harflerde küçük olmalıdır.

class StringTokonizer
class Vector
interface TestTableModel

Method İsimleri

Method isimleri her zaman fiil olmalıdır. İlk harf her zaman küçük olmalıdır. Eğer iki veya daha fazla kelimden oluşuyorsa diğer kelimelerin ilk harfi büyük olmalıdır.

get();
getName()
getTestMarkupName();

Değişken İsimleri

Sabit'ler dışındaki tüm değişkenlerin ilk harfi küçük olmalıdır. İki veya daha fazla kelimeden oluşuyorsa diğer kelimelerin ilk harfi büyük olmalıdır. Sabit'lerin tüm harfleri büyük olmalıdır. İki veya dafa fazla kelimeden oluşuyorsa araya _ işareti konulur.

int i;
int test;
int testTool;
Vector theNameNumbers;
public final static int MAX_NUMBER_ERROR=5;