C++ Yorum Satırları (comments)

 C++ ya da diğer hemen hemen tüm programlama dillerinde yorum satırları, kendinize ya da kodunuzu okuyacak olan diğer kişilere yazacağınız ve derleyicinin kodunuzu derlerken dikkate almayacağı açıklama satırlarıdır diyebiliriz.

C++ için iki tip açıklama satırından bahsetmek mümkündür.

Tek satırlı yorum 

İki tane bölü // işaretinin peşpeşe yazılmasından sonra yazılacak herşey yorum olarak kabul edilir.

#include <iostream>
 
int main() 
{
	// Tek satırda yorum yazma
	int a; // satır sonuna yorum yazabilirsiniz.
}

C Stili Blok halinde yorum satırları

Sıralı bölü ve yıldız  /* işaretlerinden sonra yorum yazmaya başlayabilir, yine sıralı yıldız ve bölü işareti */ ile yorum yazmayı istediğiniz yerde ve sütunda bitirebilirsiniz. Bu iki işaret içerisinde ne yazarsanız yazın buna C++ syntaxları da dahil, yorum olarak işlem görürler. C ve C++ için geçerlidir.

#include <iostream>
 
int main() 
{
	/*
	 Bu bir yorum bloğudur, 
	 derleyici tarafından dikkate alınmazlar
	 C++ a ait reserved words ya da söz dizimi olsa bile
	 int a = 5 sadece bir yorumdan ibarettir.
	*/
	
	int a; 
}

aşağıdaki gibi kullanımları da mümkündür:

void fonksiyonum( /*ilk parametre */ int a, /*ikinci parametre*/ int b)

Yorum Satırlarının Kullanım Amaçları ve Önemi

Her programlama dilinde geçerli olabilecek şekilde yorum satırlarının önemini kısaca şöyle sıralayabiliriz:

  • Kod okunurluğu ve bakımının kolayca yapılabilmesi için açıklamalar eklemiş oluruz, bu sayede ek olarak kod için döküman hazırlamanız gerekmez.
  • Yazılan bir fonksiyonun nasıl kullanıldığı hangi parametreleri aldığı ve bu parametrelerle neler yaptığı hangi sonucu ürettiği gibi bilgileri yazıp, kodu okuyan kişinin bu fonksiyonu kullanmasını basitleştirebiliriz. Emin olun zaman zaman bunu siz bile hatırlamıyor olabiliyorsunuz.
  • Kod geçmişi bilgilerini ve yapılan revizyonlardaki yeniliklerden bahsedebiliriz.
  • Kodu yazan kişinin bilgilerini iletişim bilgilerini ve varsa telif hakkıyla alakalı notlarımızı yazabiliriz.
Yukarıdaki disipline uymak zorunda değiliz ancak uyuyor olursak, kodda yaptığımız her değişikliği  değişiklik tarihini ve bu değişikliği yapan kişi bilgilerini revizyonlar kısmına eklemeliyiz, Bunun size ek olarak bir yük getireceğine dair bir çekinceniz yoksa kod satırları paylaşım dostu uygulamalardır, kodunuza daha resmi bir görünüm kazandırırlar. Ancak yine de yorum satırlarında aşırıya kaçılması kodun okunabilirliğini zora sokup rahatsız edici bir durum halini alabilir.

Benim de en çok kullanma sebebim olan son kullanma gereksinimi ise bir kod bloğunu yoruma çevirmektir. Kodun geliştirilmesi aşamasında bir işi yapmak için bir çok farklı yöntem deneyebilirsiniz. Bir yöntemi denediniz verim alamadınız, ancak belki o blokla alakalı spesifik bir şeyi atlamış olabileceğiniz fikri de kodu silmenize müsaade etmiyor olur, bu durumda kodu yorum bloğu haline getirip diğer yöntemi deneyebilirsiniz. Bazı durumların ekrana yazılması gerekmez ama o andaki değerini görmek için siz yazdırmış olabilirsiniz, kodun o kısmı bittiğinde bu yazdırma satırlarını da orijinal tabiriyle "comment-out" yapıp kurtulabilirsiniz. Merak etmeyin bu yolda ilerledikçe bahsettiğim şeyleri çok kullanıyor olacaksınız. :)


Önceki Konu : C++ Merhaba Dünya



Yorumlar

Bu blogdaki popüler yayınlar

Arduino IDE Kod Satır Numaraları Nasıl Açılır

DMD2TUR | Arduino P10 Led Panel için Türkçe Karakter Desteği | Arduino P10 Led panel Türkçe yazı yazma

P10 Led Panel Nasıl Sürülür - Arduino kod