Kitapta görmüş olduğumuz örneklerde dikkat etmişsinizdir;evden eve nakliyat bir program içerisinde iki tür satır vardır; Komut satırları ve komutların açıklamaları. Açıklamalara birkaç örnek verelim..,ankara nakliyat // Değişkenleri tanımlayalım // Kullanıcının girdiği değeri kontrol edelim // Ortak katların en küçüğünü hesaplayalım (OKEK) // Kelimenin harf sayısını tespit edelim

Örnek bir programcıdan beklenen iki önemli şey vardır. Birincisi, her programın, modülün, fonksiyonun başına, söz konusu kodun ne yaptığını anlatan bir açıklama bölümü eklemektir. Bu şekilde, program hakkında genel bir fikir sahibi olmak isteyen herhangi biri, açıklamaları okuyarak amacına ulaşabilir.

ikincisi ise, satır aralarına her bir kod bloğunun ne yaptığını anlatan açıklamalar eklemektir. Bu şekilde, programın belli bir bölümüne odaklanarak işlemin nasıl bir mantıkla yürütüldüğünü anlamak isteyen biri, programcı olmasa bile amacına ulaşabilir.

Program satırları arasındaki açıklamalar, teknik olmaktan ziyade mantığı açıklayıcı nitelikte olmalıdır. Bu konuda ölçünüz şu olmalı: “Programcı olmayan biri sadece açıklamaları okuduğunda, kodun ne yaptığını aşağı yukarı anlayabilir mi?”. Cevabınız olumlu ise, kendinizle gurur duyabilirsiniz.

Ayrıca bu açıklamalar; 2-3 sene sonra programınızı daha fazla geliştirmeniz gerektiğinde size de son derece faydalı olacaktır. Programı bitirdiğiniz anda her modüle, fonksiyonların ankara nakliye her bir satırına hakim hissedebilirsiniz kendinizi; içinizi “Yer yerinden oynasa unutmam ben bu yazdıklarımı” duygusu kaplayabilir. Ne var ki, ne yaparsanız yapın zaman hafızanızın aleyhine işleyecektir. Kendi programınıza bir süre sonra evden eve nakliyat tekrar döndüğünüzde, neler yapmış olduğunuzu çabucak hatırlamanızı sağlayacak olan şey, yine kendi yazdığınız açıklamalardır.

Peki, ne kadar açıklama yazmak gerekir?

Bu, cevabı programcıdan programcıya değişen bir soru. Yine de, sizinle kendi açıklama alışkanlığımı paylaşmak istiyorum. Ben program yazarken, program içerisindeki her satır öncesine açıklama koymam. Bunun yerine, söz konusu modülü kafamda adımlara ayırırım ve açıklamamı her bir adımın başına yazarım. Kitaptaki örneklerde bu stili açıkça görmeniz mümkün.Ayrıca dikkatli bakarsanız, bu adımların aynı zamanda akış şemasındaki adımlara karşılık geldiğini de görebilirsiniz.

Eğer karışık bir algoritmayla uğraşıyorsanız ve nakliyat ankara koda bakan birinin ne yapmak isteyeceğini tam olarak anlayamayacağından çekmiyorsanız, daha fazla açıklama koymaktan çekinmeyin. Fazla açıklama, eksik açıklamadan çok daha iyidir. Kodun okunabilirliğini azaltmamaya özen gösterin yeter.

Popularity: 1% [?]