C++ Yorumları: Tek Satır // ve Çok Satırlı /* */

Yorumlar Ne İşe Yarar

Yorum, C++ derleyicisinin tamamen yok saydığı, kaynak kodunuzdaki metindir. Derlenmiş programa asla ulaşmaz - yalnızca kodu okuyan insanlar için vardır. Yorumları, bir şeyin neden belirli bir şekilde yapıldığını açıklamak, hatırlatıcı bırakmak veya kodu silmeden geçici olarak devre dışı bırakmak için kullanırsınız.

Halihazırda bildiğiniz C++ söz dizimi üzerine inşa edersek, yorumlar neredeyse her yere koyabileceğiniz ve derleyicinin basitçe atlayacağı az sayıdaki şeyden biridir. C++'ın iki türü vardır: tek satır (//) ve çok satırlı blok yorumları (/* */).

Tek Satır Yorumlar

İki eğik çizgi (//) geçerli satırın sonuna kadar süren bir yorum başlatır. Derleyici //'den satır sonuna kadar olan her şeyi atlar.

#include <iostream>
using namespace std;

int main() {
    // Konsola bir selamlama yazdır
    cout << "Hello, C++!" << endl;

    int score = 90; // bir yorum kodun ardından da yer alabilir
    cout << score << endl;
    return 0;
}

İkinci yorumun gerçek kodla aynı satırı paylaştığına dikkat edin. //'den önceki her şey yine de çalışır; yalnızca ondan sonraki kısım yok sayılır. Bu, kısa notlar için en yaygın yorum biçimidir.

Çok Satırlı Blok Yorumlar

Notunuz birkaç satıra yayıldığında, her satırın başına // koymaktansa blok yorum daha temizdir. Bir blok yorum /* ile başlar ve */ ile biter. İkisi arasındaki her şey - kaç satır olursa olsun - yok sayılır.

#include <iostream>
using namespace std;

int main() {
    /*
     * Bu program bir blok yorumu gösterir.
     * Her satırın başındaki yıldız işaretleri yalnızca
     * okunabilirlik için bir gelenektir - zorunlu değildir.
     */
    cout << "Block comments are handy." << endl;
    return 0;
}

Sol kenar boyunca hizalanmış * karakterleri bir stil geleneğidir, kural değil. Asıl önemli olan tek şey, açılış /* ve kapanış */'dir. Bir blok yorum bir satırın ortasında bile yer alabilir - int x = 5 /* width */ + 2; geçerlidir - ancak bu hızla okunması zor bir hale gelir.

Kodu Yorum Satırına Alma

Yorumlar, denemeler yaparken kodu silmeden devre dışı bırakmanın standart yoludur. Tek bir satır için //, aynı anda birkaç satırı kapatmak için bir blok yorum kullanın.

#include <iostream>
using namespace std;

int main() {
    cout << "This line runs." << endl;

    // cout << "This line is disabled." << endl;

    /*
    cout << "So is this one," << endl;
    cout << "and this one too." << endl;
    */

    cout << "This line runs as well." << endl;
    return 0;
}

Çalıştırın ve yalnızca iki "runs" satırının yazdırıldığını göreceksiniz. Yorum satırına alınmış cout ifadeleri derleyici için görünmezdir.

İç İçe Geçmeme Tuzağı

Yeni başlayanları yakalayan bir tuzak: blok yorumlar iç içe geçmez. Öncesinde kaç tane /* gelmiş olursa olsun ilk */ yorumu kapatır. Yani bir /* ... */ bloğunu başka bir /* ... */ bloğunun içine saramazsınız - içteki */ her şeyi sonlandırır ve ondan sonrası yeniden koda dönüşür (genellikle bir söz dizimi hatası).

/*  Trying to disable a region that already has a block comment...
    int n = 10; /* the width */
    cout << n;
*/  // the first */ above already closed the comment - this line is now stray code

Dıştaki yorum the width'ten sonraki */'de biter, dolayısıyla geri kalan artık yorum satırı değildir ve derleyici sondaki */'de takılır. Zaten blok yorum içeren bir bölgeyi devre dışı bırakmanız gerektiğinde, her satıra // koyun. Çoğu düzenleyici, tek bir klavye kısayoluyla bir seçimin tamamında satır yorumlarını açıp kapatır ve böylece bu sorunu tamamen aşar.

İyi Yorumlar ve Gürültü

Bir yorum, kodun kendi başına söyleyemeyeceği bir şeyi açıklamalıdır. Yalnızca kodu tekrar eden yorumlar karışıklık yaratır ve kod değiştikçe güncelliğini yitirme eğilimindedir.

// Bad: just repeats what the code obviously does
i = i + 1; // add one to i

// Better: explains the reason, which the code can't show
retries++; // back off and retry; the API is rate-limited at 5 req/sec

Kodu açık adlar ve iyi bir yapı aracılığıyla okunabilir kılmayı hedefleyin ve yorumları neden için saklayın: niyet, ödünleşimler, kenar durumları ve bağlama yönelik bağlantılar. Kafa karıştırıcı bir satırı açıklamak için yorum yazdığınızı fark ederseniz, bu genellikle bir değişkeni yeniden adlandırmanız veya mantığı iyi adlandırılmış bir işleve bölmeniz gerektiğinin bir işaretidir.

Sonraki: Değişkenler

Artık kodunuza açıklama ekleyebildiğinize göre, bir sonraki yapı taşı içinde veri saklamaktır. Sonraki sayfa değişkenleri ele alır: bunları nasıl tanımlayacağınızı, tuttukları yerleşik türleri ve C++'ın statik olarak türlenmiş olduğu için dayattığı kuralları.