Kod Yazım Kuralları

Bu yazıda “Kod yazım kuralları neden önemli?” ve  “Kod yazım kuralları nelerdir, nelere dikkat etmek gerekir?” gibi sorulara cevap bulacaksınız.

Öncelikle, bir programcı programlama yaparken kodun okunabilir olmasına dikkat etmelidir. Okunabilir kod nedir diyecek olursanız; okunabilir kod, kodu yazanların ya da kodu yazanlar dışındaki program geliştiricilerin projeyi incelediğinde ne işe yaradığını anlayabildiği, fonksiyon ve değişken adlandırmaları, girintileri ve satır boşlukları ayarlanmış, anlaşılır yorum satırları olan koddur.

Okunabilir kod yazmak için belli bir alışkanlığa sahip olmanız gerekir. Kod yazım kurallarını derse başlamadan önce anlatmak istedim ki, başlangıçtan bu alışkanlığa sahip olursanız ileride siz rahat edersiniz.

Okunabilir, kod yazım kurallarına uygun kod yazmak belki projenin çalışmasını etkilemez; ancak neredeyse projenin çalışması kadar önemlidir. Biliyorsunuz ki proje bitse de, ileride projede değişiklikler olmayacağını garanti edemezsiniz. Dolayısıyla bir takım şeyler eklemek için, projenin kaynak kodlarına geriye dönüp bakmanız, kodları anlamanız gerekebilir. Buna ek olarak bu projede birden fazla kişi çalışıyor olabilir ve çalışan kişilerin bu kodları anlaması gerekebilir. Yazılan kodun karmaşıklığı övünülecek bir durum değildir. Aksine ne kadar hızlı kod yazıyor olursa olsun, başarısız bir programlamacıdır.

Kod yazım kurallarına uymak aynı zamanda, kod parçalarının kullanabilirliğini de arttırır. Kodu fonksiyonlar ya da metotlar halinde yazmak, aynı işi yapan kodları tekrar tekrar yazmanızı engeller ve veriminizi arttırır.

Kod yazım kurallarına gelecek olursak;

İsimlendirmeyi iyi yapın:

• İsimlendirmede Türkçe karakter kullanılmamasına dikkat etmek gerekir.
• İsimler değişkenlerin kullanım amacına uygun olması gerekir.
• Yazması uzun olur diye düşünüp değişken isimleri kısaltılmamalıdır.
• Döngü değişkenleri dışında tek ya da iki harfli değişken isimleri seçmek yanlış bir tercihtir. (i,j,k,l,m,…gibi değişken isimleri döngüde kullanılabilir.)
• Sınıf adları; büyük harfle baslar ve birden çok kelime içeren sınıf adlandırması yapılacaksa her bir kelimenin baş harfi de büyük yazılmalıdır. (Bitkiler,BitkiCesitleri,… )
• Fonksiyon(metot) adları; küçük harfle başlar ancak birden fazla kelime içerirse diğer kelimeler büyük harfle başlamalıdır.(hesapla,toplamaYap,…)
• Özellikle büyük projelerde, değişken isimlerinin değişkenin veri tipini ifade eden bir harfle başlaması tercih edilir.(enum yapısı için eDegisken, integer için iDegisken, float için fDegisken,…)

Girintiler ve Boşlukları iyi ayarlayın:

• Biçimli, güzel görünümlü kod yazmaya özen göstermek gerek. Açılan parantezin kapandığı yere dikkat etmek gerekir. Eclipse’de girinti, çıkıntıların ve boşlukların düzenli olmasını sağlayan “Format” özelliği vardır. Bu konu da sık başvuracağınız bir özellik.
• Bir kod başka bir kod bloğunun içindeyse mutlaka bir tab’lık alan sağda olsun.

1 2 3 4 5

public class Main {       public static void main(String args[]){            System.out.println("Hello Java!");        } }

Kodlarınızı yazarken sınıflara ve metotlara ayırın:

• Geliştirdiğiniz algoritmaları metotlar içinde yazarsanız, ileride aynı algoritmayı kullanmak istediğinizde sizin için kolaylık olur.
• Metotları yazarken, her bir metot bir işi yerine getirsin. Yalınlıktan yana olun. Emin olun bu işinize yarayacaktır.
• Kısa kısa metotlar yazmak hata yapma oranınızı azaltacağı gibi, hatalarınızı da daha kolay bulmanızı sağlayacaktır.

Açık ve anlaşılır yorumlar yazın:

• Mutlaka yazdığınız her fonksiyona fonksiyonun ne iş yaptığını anlatan açıklayıcı yorumlar yazın.
• Kod parçacıklarına yaptığınız yorumlar, sizin dışınızdaki program geliştiricisinin anlayabileceği ve sizinde ileride bakıp anlayacağınız şekilde olmalıdır.

Yazıyı bitirmeden önce şunu aklınızdan çıkarmayın, bahsettiğim kod yazım kuralları yazılı, mutlaka uyulması gereken kurallar değildir. Bu kurallara uygun yazmasanız da kodlarınız çalışır ancak bu sizi iyi programcı yapmaz. İyi bir programcı olmanın yolu anlaşılır, okunaklı ve kod yazım kurallarına uygun kod yazmaktan geçer.

Kod yazarken belirli bir yazış biçimi belirleyin ve ona sadık kalın. En önemlisi programlamayla kalın…