Üye
Selam yoldaşlar, ben FackCapital (BKZ: Anti Kapitalist). Bugün C++ Bible dokümantasyonunun ikinci bölümü olan yorum satırları bölümü ile karşınızdayım. Tavsiyem ilk bölümü eğer okumadıysanız, bu bölüme geçmeyin. Bu bölümde diğer bölümün aksine opsiyonel bir konuya değineceğiz (Okunabilir Kod Yazma Sanatı). Bence muhakkak öğrenilmesi gereken önemli bir konu ancak siz yine de ben sadece kod yazmak istiyorum bana ne okunabilirliğinden diyorsanız bu kısımları okuyarak vakit kaybetmenize gerek yok.
Kısaca Yorum Satırları
Yorum satırlarını kısaca anlatmamız gerekirse programın kaynak koduna eklenebilen ve sadece programcı tarafından okunabilen bir çeşit nottur. Program derlenirken yorum satırları göz ardı edilir, yorum satırlarının programcı sadece işini kolaylaştırmak için kullanır. Yorum satırları bir geliştiricinin kodun mantığını açıklamasına ve okunabilirliği arttırmasına yardımcı olur. Okunabilir kod yazmak bir çeşit sanattır, iyi programcılar her zaman bu sanatı dikkate alır. Peki nedir bu okunabilir kod sanatı? Şimdilik okunabilir kod yazma sanatına ufak bir atlama yapıyorum eğer ilginizi çekmiyorsa bu sanat bu bölümleri geçebilirsiniz.
Okunabilir Kod Yazma Sanatı (Opsiyonel)
İyi yazılmış bir kod iki temel gereksinimi karşılaması gerekir. Birincisi kod düzgün bir şekilde çalışmalı yani verilen görevi layığıyla yerine getirmelidir, ikincisiyse başka programcılar tarafından okunduğunda anlaşılır olması gerekmektedir. Ancak bazı kodlar vardır ki o kadar leş yazılmıştır ki yüzüne bakmazsınız. Bu yüzden okunabilir kod yazmak bir çeşit sanattır, yazdığınız kodu bir başkası okuduğunda anlayabilmesi gerekir, bu başkası kendiniz bile olsa. Yani ben zaten yazdığım kodları kimseyle paylaşmayacağım demek gibi bir hataya düşmeyin. Çünkü programlamada ilerlediğinizde fark edeceksiniz ki yazdığınız kodlar her geçen gün daha kompleks bir hal alacak. Bu tarz durumlarda geriye dönüp baktığınızda ne yapmaya çalıştığınızı anlamanız önemli. Burada anlamak derken sadece okunup anlaşılmasını değil, başka bir programcı yazmış olduğunuz programı anlayıp üzerinde ne kadar değişiklik yapabilir? Bu ve benzeri sorunlarda Okunabilir Kod Yazma Sanatının bir parçasıdır.
Okunabilir Kod Neden Önemlidir?
Okunabilirlik neden bu kadar önemli? Okunabilirliğin bu kadar önemli olmasının temel sebebi, yazmış olduğunuz programda bir hatayla karşılaştığınız zaman bu hatayı çözerken okunabilir kodun size daha fazla zaman kazandırmasıdır. Aynı zamanda açık kaynak kodlu bir proje geliştiriyorsanız projenize ekleme yapmak isteyenler kodunuzu daha rahat bir şekilde anlayıp üzerinde oynama yapabilir.
Az Kodla İş Bitirmek Daha mı İyidir
Genellikle bir işi daha az kodla halletmek daha iyidir ancak her zaman için bu durumun geçerli olduğunu söylememiz pek mümkün değil.
İyi Değişken İsimleri Belirleyin
Programlamada değişkenlerin yeri büyüktür ancak gözlemlerim doğrultusunda şunu fark ettim ki pek az programcı değişkenlere verilen isimleri ciddiye alıyor. Değişken nedir bilmeyenler için kısaca bir özetleyelim: Değişkenler bir programda işlenecek verileri depolamak için kullanılır. Örneğin herhangi bir oyunda oyuncunun canı, mermisi vb. değerler değişkenlerde saklanır. Yazacağımız programlarda birçok değişken ile uğraşmak zorunda kalacağız, bu yüzden bu değişken isimlendirme işini ciddiye almanızı öneririm.
Yazdığınız koda açıklama satırı eklemeniz çok önemlidir. Evet, belki şuan neyi ne amaçla yazdığınızı çok iyi biliyor olabilirsiniz. Ancak aradan uzun bir zaman geçtikten sonra kodunuza dönüp baktığınızda neyi niçin yazdığınızı unutabilirsiniz. Özellikle açık kaynak kodlu projeler geliştirmeyi düşünüyorsanız açıklama satırı yazmanın değeri yadsınamaz.
Dediğim gibi şuan okunabilir kod yazma olayı tamamen opsiyonel olduğu için şimdilik bu kısmı bende geçiyorum çünkü yazmaktan sıkıldım. Söz vermiyorum ama belki ilerleyen bölümlerde, bu konuya da ayrı bir dil atabiliriz. Neyse şimdi o zaman tekrardan yorum satırlarına geri dönelim.
Yorum Satırları
C++ programlama dilinde aynı amaca hizmet eden iki çeşit yorum satırı bulunmaktadır.
Tek Satırlı Yorumlar
// ile başlayan tek satırlı yorumlar, derleyiciye bu sembolden itibaren (//) satırın sonuna kadar her şeyi göz ardı etmesi gerektiğini bildirir. Örneğin:
Genellikle tek satır yorumları, tek satırlık bir kod hakkında açıklama yapmak için kullanılır.
Bir satırın tam yanına yorum yapmak gördüğünüz üzere kodun okunmasını kolaylaştırması gerekirken biraz daha zorlaştırdı. O zaman yorum satırları her zaman kodun okunabilirliğini arttırmıyormuş bunu öğrendik.
Yukarıda gördüğünüz kodu okumak daha kolay değil mi? Ancak yine de uzun satırlı kodlarda yorum yapmanız gerekebilir. Bu tarz durumlarda en iyisi yorum satırı yazacağınız kodun üzerine yazmaktır.
Çok Satırlı Yorumlar
C++ programlama dilinde çok satırlı yorum yazmak için /* ve */ sembollerini kullanırız. Çok satırlı yorumlar arasına yazdıklarımız tek satırlı yorumlarda olduğu gibi derleyici tarafından çalıştırılmaz.
Çok satırlı yorumlar iç içe yerleştirilemez. Eğer böyle bir şey denerseniz şu şekilde bir sonuç alırsınız:
Mümkün olduğu kod yorum satırları içinde yorum satırı kullanmamaya dikkat edin!
Yorum Satırlarının Doğru Kullanımı
Yorum satırları en çok bir fonksiyonun veya kütüphanenin ne gibi bir amaca hizmet ettiğini açıklamak için kullanılır. Bu tarz yorum satırları genellikle kodun en üst kısmına yazılır ve programcının daha kodu incelemeden o kodun ne amaçla yazıldığını anlaması amaçlanır. İyi bir yorum satırı sayesinde kodunuzu okuyan kişi programlamadan anlamasa bile ifadenin üzerine yazdığınız yorum satırı ile o ifadenin ne amaçla yazıldığı anlaşılır. Ancak burada önemli bir nokta devreye giriyor yorum satırı bir ifadenin ne amaçla yazıldığını açıklamak için kullanılır, ne yaptığını açıklamak için kullanılmaz. Yani yorum satırı kullanmanın da bir adabı vardır. Örneğin:
Bu şekilde bir yorum satırı yazmamıza gerek yok çünkü zaten ifadeyi gördüğümüzde X değişkenine 0 değerinin atandığını anlıyoruz.
Yorum Satırları Kod Üzerinde Deney Yapmamıza Olanak Sağlar
Çok kompleks bir program yazdığınızı hayal edin. Programınızda bir hata çıkmış olsun ancak hatanın nerede olduğunu da bir türlü bulamıyorsunuz. İşte burada yardımınıza yorum satırları koşuyor. Yorum satırları sayesinde hata olduğundan şüphelendiğiniz kısmı yorum satırı içine alıp programı çalıştırabilirsiniz. Bu sayede hem kodunuz silinmemiş olur hem de derleyici hatalı olmasından şüphelendiğiniz kısmı çalıştırmaz.
Evet, bu bölümde C++ programlama dilinde yorum satırlarını ve okunabilir kod yazma sanatına değindik. Umarım sizin içinde bilgilendirici bir bölüm olmuştur. Bir sonraki bölümde görüşmek üzere...
Bölüm 1: Bir C++ Programının Yapısı ve İfadeler [C++ Bible]
Kısaca Yorum Satırları
Yorum satırlarını kısaca anlatmamız gerekirse programın kaynak koduna eklenebilen ve sadece programcı tarafından okunabilen bir çeşit nottur. Program derlenirken yorum satırları göz ardı edilir, yorum satırlarının programcı sadece işini kolaylaştırmak için kullanır. Yorum satırları bir geliştiricinin kodun mantığını açıklamasına ve okunabilirliği arttırmasına yardımcı olur. Okunabilir kod yazmak bir çeşit sanattır, iyi programcılar her zaman bu sanatı dikkate alır. Peki nedir bu okunabilir kod sanatı? Şimdilik okunabilir kod yazma sanatına ufak bir atlama yapıyorum eğer ilginizi çekmiyorsa bu sanat bu bölümleri geçebilirsiniz.
Okunabilir Kod Yazma Sanatı (Opsiyonel)
İyi yazılmış bir kod iki temel gereksinimi karşılaması gerekir. Birincisi kod düzgün bir şekilde çalışmalı yani verilen görevi layığıyla yerine getirmelidir, ikincisiyse başka programcılar tarafından okunduğunda anlaşılır olması gerekmektedir. Ancak bazı kodlar vardır ki o kadar leş yazılmıştır ki yüzüne bakmazsınız. Bu yüzden okunabilir kod yazmak bir çeşit sanattır, yazdığınız kodu bir başkası okuduğunda anlayabilmesi gerekir, bu başkası kendiniz bile olsa. Yani ben zaten yazdığım kodları kimseyle paylaşmayacağım demek gibi bir hataya düşmeyin. Çünkü programlamada ilerlediğinizde fark edeceksiniz ki yazdığınız kodlar her geçen gün daha kompleks bir hal alacak. Bu tarz durumlarda geriye dönüp baktığınızda ne yapmaya çalıştığınızı anlamanız önemli. Burada anlamak derken sadece okunup anlaşılmasını değil, başka bir programcı yazmış olduğunuz programı anlayıp üzerinde ne kadar değişiklik yapabilir? Bu ve benzeri sorunlarda Okunabilir Kod Yazma Sanatının bir parçasıdır.
Okunabilir Kod Neden Önemlidir?
Okunabilirlik neden bu kadar önemli? Okunabilirliğin bu kadar önemli olmasının temel sebebi, yazmış olduğunuz programda bir hatayla karşılaştığınız zaman bu hatayı çözerken okunabilir kodun size daha fazla zaman kazandırmasıdır. Aynı zamanda açık kaynak kodlu bir proje geliştiriyorsanız projenize ekleme yapmak isteyenler kodunuzu daha rahat bir şekilde anlayıp üzerinde oynama yapabilir.
Az Kodla İş Bitirmek Daha mı İyidir
Genellikle bir işi daha az kodla halletmek daha iyidir ancak her zaman için bu durumun geçerli olduğunu söylememiz pek mümkün değil.
C++:
//İlki
assert((!(bucket = FindBucket(key))) || !bucket->IsOccupied());
//İkincisi
bucket = FindBucket(key);
if (bucket != NULL) assert(!bucket->IsOccupied());
//Bu kod satırı The Art of Readable Code kitabından alınmıştırİyi Değişken İsimleri Belirleyin
Programlamada değişkenlerin yeri büyüktür ancak gözlemlerim doğrultusunda şunu fark ettim ki pek az programcı değişkenlere verilen isimleri ciddiye alıyor. Değişken nedir bilmeyenler için kısaca bir özetleyelim: Değişkenler bir programda işlenecek verileri depolamak için kullanılır. Örneğin herhangi bir oyunda oyuncunun canı, mermisi vb. değerler değişkenlerde saklanır. Yazacağımız programlarda birçok değişken ile uğraşmak zorunda kalacağız, bu yüzden bu değişken isimlendirme işini ciddiye almanızı öneririm.
- Değişkenlerinizin isimlerini İngilizce yazın. Programlamada, programcıların kullandığı ortak dil İngilizcedir bu yüzden başka bir yabancının kodunuzu anlayabilmesi için değişkenlerinizi İngilizce dilinde isimlendirmeniz naçizane tavsiyemizdir.
- Türkçe karakter veya özel karakter kullanmayın.
- C++ anahtar kelimelerini değişken adı olarak koymaya çalışmayın. C++ anahtar kelimelerine örnek vermemiz gerekirse: char, bool, and, class vb.
- Değişken isimlerine küçük harfle başlamayın.
- Değişken isimlendirirken kelimeler arası boşluk kullanmayınız. Boşluk yerine bitişik veya alt tire kullanabilirsiniz. Şahsen ben alt tire kullanma taraftarıyım.
Yazdığınız koda açıklama satırı eklemeniz çok önemlidir. Evet, belki şuan neyi ne amaçla yazdığınızı çok iyi biliyor olabilirsiniz. Ancak aradan uzun bir zaman geçtikten sonra kodunuza dönüp baktığınızda neyi niçin yazdığınızı unutabilirsiniz. Özellikle açık kaynak kodlu projeler geliştirmeyi düşünüyorsanız açıklama satırı yazmanın değeri yadsınamaz.
Dediğim gibi şuan okunabilir kod yazma olayı tamamen opsiyonel olduğu için şimdilik bu kısmı bende geçiyorum çünkü yazmaktan sıkıldım. Söz vermiyorum ama belki ilerleyen bölümlerde, bu konuya da ayrı bir dil atabiliriz. Neyse şimdi o zaman tekrardan yorum satırlarına geri dönelim.
Yorum Satırları
C++ programlama dilinde aynı amaca hizmet eden iki çeşit yorum satırı bulunmaktadır.
Tek Satırlı Yorumlar
// ile başlayan tek satırlı yorumlar, derleyiciye bu sembolden itibaren (//) satırın sonuna kadar her şeyi göz ardı etmesi gerektiğini bildirir. Örneğin:
C++:
std::cout << "Selamün Aleyküm, Dünya!"; // Buradan itibaren derleyicide her şey göz ardı edilir
C++:
std::cout << "Selamün Aleyküm, Dünya!\n"; // iostream kütüphanesi sayesinde bu satırı yazabiliyoruz
std::cout << "Senle tanışmak ne güze!\n"; // bu açıklamalar kodun okunmasını zor bir hale getiriyor
std::cout << "Evet!\n"; // genellikle satırlar farklı uzunluktadır
C++:
std::cout << "Selamün Aleyküm, Dünya!\n"; // Buradan itibaren derleyicide her şey göz ardı edilir
std::cout << "Senle tanışmak ne güzel!\n"; // bunu okuması daha kolay
std::cout << "Evet!\n"; // Sence de öyle değil mi?
C++:
// iostream kütüphanesi sayesinde bu satırı yazabiliyoruz
std::cout << "Selamün Aleyküm, Dünya!\n";
// bunu okuması daha kolay
std::cout << "Senle tanışmak ne güzel!\n";
// Sence de öyle değil mi?
std::cout << "Evet!\n";Çok Satırlı Yorumlar
C++ programlama dilinde çok satırlı yorum yazmak için /* ve */ sembollerini kullanırız. Çok satırlı yorumlar arasına yazdıklarımız tek satırlı yorumlarda olduğu gibi derleyici tarafından çalıştırılmaz.
C++:
/* Bu çok satırlı bir yorum.
Bu satır göz ardı edilecek.
İşte! bir satır daha */
C++:
/* Bu bir çok satırlı /* yorumdur */ bu ifade yorum satırının içinde değil */
// Yukarıda ki yorum ilk sembolle bitti */, ikinci sembolle değil */Yorum Satırlarının Doğru Kullanımı
Yorum satırları en çok bir fonksiyonun veya kütüphanenin ne gibi bir amaca hizmet ettiğini açıklamak için kullanılır. Bu tarz yorum satırları genellikle kodun en üst kısmına yazılır ve programcının daha kodu incelemeden o kodun ne amaçla yazıldığını anlaması amaçlanır. İyi bir yorum satırı sayesinde kodunuzu okuyan kişi programlamadan anlamasa bile ifadenin üzerine yazdığınız yorum satırı ile o ifadenin ne amaçla yazıldığı anlaşılır. Ancak burada önemli bir nokta devreye giriyor yorum satırı bir ifadenin ne amaçla yazıldığını açıklamak için kullanılır, ne yaptığını açıklamak için kullanılmaz. Yani yorum satırı kullanmanın da bir adabı vardır. Örneğin:
Kod:
// X değişkenine 0 değerini atadık.
int x = 0;Yorum Satırları Kod Üzerinde Deney Yapmamıza Olanak Sağlar
Çok kompleks bir program yazdığınızı hayal edin. Programınızda bir hata çıkmış olsun ancak hatanın nerede olduğunu da bir türlü bulamıyorsunuz. İşte burada yardımınıza yorum satırları koşuyor. Yorum satırları sayesinde hata olduğundan şüphelendiğiniz kısmı yorum satırı içine alıp programı çalıştırabilirsiniz. Bu sayede hem kodunuz silinmemiş olur hem de derleyici hatalı olmasından şüphelendiğiniz kısmı çalıştırmaz.
Evet, bu bölümde C++ programlama dilinde yorum satırlarını ve okunabilir kod yazma sanatına değindik. Umarım sizin içinde bilgilendirici bir bölüm olmuştur. Bir sonraki bölümde görüşmek üzere...
