Skip to main content

JavaScript’te Yorum Satırları Yazma

Giriş​

Programlama yaparken genelde ilk düşündüğümüz şey, bilgisayarın yazdığımız kodu nasıl okuyup çalıştırdığıdır.
Ama en az bunun kadar önemli olan bir şey daha var: insanlar.

Kodunuzu sizden sonra okuyacak veya üzerinde çalışacak kişiler için anlaşılır hale getirmek çok önemlidir.
İster bir ekiple çalışın ister tek başınıza, kodunuzu doğru şekilde yorumlamak (comment) ve düzenlemek, insan okuyucular için vazgeçilmezdir.

Yorum satırları, bir programın kaynak koduna eklenen ve yorumlayıcı (interpreter) tarafından görmezden gelinen açıklamalardır.
Bu yüzden kodun çıktısını etkilemezler. Ancak kodun ne yaptığını veya ne yapması gerektiğini açıklamada çok faydalıdırlar.

Bir geliştirici olarak, başkası tarafından yazılmış ama yorumlanmamış bir kodu anlamaya çalışmak gerçekten sinir bozucu olabilir.
Aynı şekilde, bir süre sonra kendi yazdığınız kodun ne anlama geldiğini unutmanız da çok kolaydır.

Kodunuza erken aşamada yorumlar eklemek, kariyeriniz boyunca size yardımcı olacak iyi bir alışkanlık kazandırır ve bu tür sorunları önler.

Yorum Söz Dizimi​

JavaScript’te yorum satırlarını yazmanın iki farklı yolu vardır.

Tek satırlık yorumlar, çift eğik çizgi // ile başlar:

 // Bu bir yorum satırıdır.

// ile başlayan yorumlarda, satırın sonuna kadar yazılan tüm karakterler JavaScript tarafından yok sayılır.

Blok yorumlar ise çok satırlı yorumlar için kullanılır.
/* ile başlar ve */ ile biter.

Eğer CSS bilginiz varsa bu yapıya zaten aşina olmalısınız.

/* Bu bir 
yorum satırıdır */

Açılış ve kapanış etiketleri arasındaki her şey JavaScript tarafından yok sayılır.

Hem tek satırlık hem de çok satırlı yorumlar, genellikle açıklama yaptıkları kodun üstüne yazılır.
Aşağıdaki Rabisu Doc'a Hoşgeldiniz..” örneğinde olduğu gibi:

// Konsola "Rabisu Doc'a Hoşgeldiniz.." yazalım.
console.log("Rabisu Doc'a Hoşgeldiniz..");

Yorum yazarken, onları hemen altındaki kodla aynı seviyede girintileyin (indent yapın):

// Bir fonksiyonu başlat
function alphabetizeOceans() {
	// oceans değişkenini stringlerden oluşan bir liste olarak tanımla
	const oceans = ["Pasifik", "Atlantik", "Hint", "Antarktik", "Arktik"];

	// Alfabetik sıralanmış diziyi konsola yazdır
	console.log(oceans.sort());
}

Sakın unutmayın, yorum satırları da programın bir parçasıdır.
Güncellenmemiş (eski) yorumlar, hiç yorum olmamasından bile daha zararlı olabilir.
Bu yüzden yorumlarınızı da kodunuzla birlikte düzenli olarak güncellemeniz önemlidir.

Satır İçi (Inline) Yorumlar​

Tek satırlık yorumlar, bir kod satırının sonunda yazıldığında inline comment (satır içi yorum) olarak adlandırılır.

let x = 99;    // x değişkenine sayısal değer ata
let y = x + 2; // x + 2 işleminin sonucunu y'ye ata

Satır içi yorumlar, küçük ve belirli kod parçaları için hızlı açıklama yapmaya yarar.
Yorum sadece bulunduğu satırla ilgili olmalıdır, bu yüzden en açık ve net yorum tipidir.

Unutmayın: Tek satırlık yorumlarda (//) satırın sonuna kadar her şey yorum kabul edilir.
Yani // yazdıktan sonra aynı satırda kod yazamazsınız. Aşağıdaki örnekte olduğu gibi:

for (let i = 0; i === 10; i++) // 10 kez çalışacak for döngüsü
{  
	// Bu kodu çalıştırmak bir sözdizimi (syntax) hatası verir
}

Satır içi yorumlar faydalı olsa da ölçülü kullanmak gerekir.
Her satırın yanına fazla yorum eklemek, kodunuzu kısa sürede karmaşık ve okunması zor bir hale getirir.

Blok Yorumlar​

Blok yorumlar (çok satırlı yorumlar), bir kod bölümünü tanıtmak veya açıklamak için kullanılan uzun açıklamalardır.
Genellikle bu tür yorumlar dosyanın en üstüne veya özellikle karmaşık bir kod bloğunun önüne yerleştirilir.

/* greetUser fonksiyonunu başlat ve çalıştır.
Kullanıcının adını bir sabite ata
ve bir karşılama mesajı yazdır. */

function greetUser() {
	const name = prompt("Adınız nedir?");
	console.log("Merhaba, " + name + "! Nasılsın?");
}

greetUser();

Bazen blok yorum söz diziminin biraz değiştirilmiş bir versiyonunu da görebilirsiniz.
Bu tür yorumlar /** ile başlar ve yorum bloğunun sol tarafında satır boyunca yıldızlar bulunur.

/**
 * Bir dizi string sabiti başlat.
 * Dizideki her öğeyi döngüyle gez
 * ve konsola yazdır.
 */

const seaCreatures = ["Köpekbalığı", "Balık", "Ahtapot"];

for (const seaCreature of seaCreatures) {
  console.log(seaCreature);
}

Bazen bu tür yorumlarda, dosyayla ilgili ek bilgiler de bulunur.
Örneğin script’in adı, sürümü veya yazar bilgisi gibi detaylar buraya yazılabilir.

JavaScript’e yeni başlıyorsanız, yazdığınız kodu anlamak için gerektiği kadar uzun yorumlar yazabilirsiniz.
Ancak zamanla kendinizi geliştirdikçe, yorumlarda “nasıl” veya “ne” sorularını değil, kodun amacını (nedenini) açıklamaya odaklanmanız daha faydalı olacaktır.

Test Amaçlı Kod Yorumlama​

Yorum satırları, yazdığınız kodun çalışmasını hızlıca engellemek için de kullanılabilir.
Buna “kodu yorum satırına almak” (commenting out code) denir.

Eğer yazdığınız kodda bir hata varsa, belirli bölümleri yorum satırına alarak çalışmasını durdurabilirsiniz.
Bu yöntem, sorunun kaynağını bulmaya yardımcı olur.
Ayrıca farklı sonuçları test etmek için kod blokları arasında geçiş yapmak amacıyla da kullanılabilir.

// İki sayıyı toplayan fonksiyon
function addTwoNumbers(x, y) {
  let sum = x + y;
  return sum;
}

// İki sayıyı çarpan fonksiyon
function multiplyTwoNumbers(x, y) {
  let product = x * y;
  return product;
}

/* Bu örnekte addTwoNumbers fonksiyonunu yorum satırına aldık.
Bu yüzden çalışmayacak. Sadece multiplyTwoNumbers fonksiyonu çalışacak. */

// addTwoNumbers(3, 5);
multiplyTwoNumbers(5, 9);

Kodunuzu yorum satırına almak için hem tek satırlık yorumları hem de blok yorumları kullanabilirsiniz.
Hangi yöntemi seçeceğiniz, yorumlamak istediğiniz bölümün büyüklüğüne bağlıdır.

Not: Kodunuzu yorum satırına almak sadece test amaçlı yapılmalıdır.
Son haliyle teslim edeceğiniz veya yayınlayacağınız dosyada, yorum satırına alınmış kod parçaları bırakmayın.

Bir programın mantığını çözmeye çalışırken, kodu yorum satırına almak oldukça faydalı olabilir.
Bu yöntemle hataların nerede olduğunu bulabilir veya hangi kod satırlarının gerçekten işe yaradığını değerlendirebilirsiniz.

Sonuç​

JavaScript kodu bilgisayar tarafından çalıştırılır, ama her zaman başka programcılar tarafından da okunur. Özellikle karmaşık bölümlere doğru yorumlar eklemek, ileride size fazlasıyla fayda sağlayacaktır.
Böylece hem siz hem de ekip arkadaşlarınız, yazdığınız kodun amacını çok daha kolay anlayabilirsiniz.