Bu kodu yorumlamalı mı yorumlamamalı mı?

Emir Buğra KÖKSALAN tarafından tarihinde yayınlandı

Yazılan kodun herkes için anlaşılabilir olması çok önemlidir. Algoritma ne kadar karmaşık olursa olsun ilk bakışta anlaşılabilir olması gerekir. Olabildiğince mantıklı şekilde isimlendirme yapılmalı, girintilemeye dikkat edilmeli, benzer satırlar gruplanmalı ve gruplar birbirinden bir boş satır ile ayırılmalı. Bunu zaten herkes yapıyor. Fakat bir de algoritmanın bütün olarak kısa sürede anlaşılması konusu var. Mümkün olduğunca doğru kütüphaneler kullanılmalı, kütüphaneyi kendimiz yazıyorsak yine isimlendirme kurallarına uyulmalı. Böl ve zaptet mantığı kodun heryerinde kullanılmalı. Bunları yaparsak çok daha anlaşılır kodlar yazabiliriz fakat bazı zamanlar oluyor ki derleyicinin dikkate almadığı ama programcı için çok önemli bilgiler ihtiva eden yorum satırları yazmak gerekebiliyor.

Yorum yazma konusu biraz da o programlama dilinin kültürüyle alakalı olabiliyor. Örneğin PHP dilini kullanıp da yorum yazmamak sanki ateş yakılmadan nevruz kutlamaya benziyor. Fakat Java dili söz konusu olunca neredeyse hiç yorum yazmadan onbinlerce satır kod yazabilirsiniz. Bunun ana sebebi dilin sintaksı ve bazı gizli kuralları. Örneğin PHP’de “===” ifadesi ile “==” ifadesi aynı şey değildir. Bu farklılığı ilk bakışta anlayamayabiliyoruz. Bazen dalgınlıktan bazen de değişkenlerin özel durumlarından ötürü iki ifade farklı şekilde çalışıyor. Bu ifadeyi kullandığımız satıra dikkat çekmek amacıyla ufak bir yorum atılabilir. Gelelim Java diline. Javada üç eşittir ifadesi yok. Mecburen herşeyi çift eşittirle kontrol ediyorsunuz. Böyle olunca da kodu ona göre yazdığınız için bir eşittir karakterinin sebep olabileceği görünmez buglardan ve anlaşılması güç durumlardan otomatikman kaçınmış oluyorsunuz. Sınırlarınız daha belirgin, önünüz daha açık, ne yapacağınızı daha keskin bir şekilde biliyorsunuz. Buraya yorum satırı koymanıza gerek kalmıyor.

Yorum satırı yazma konusu Clean Code isimli kitapta çok güzel ve detaylı şekilde ele alınmış. Bu kitabı okuyup bitirdiğinizde size doğru gelen ama aslında yanlış olan alışkanlıklarınızın neden yanlış olduğunu çok daha iyi anlıyorsunuz. Bu kitap daha çok Java dili için yazılmış olsa da her dil için uyarlanabilir. Aslında bu konuyla ilgili birkaç makale yazılabilir ama benim amacım sadece bir konuya dikkat çekmek. Bu yüzden burada bırakıyorum. Kod yazan arkadaşlara tavsiyem yorum yazma konusunu araştırmaları ve doğru bildikleri yanlışları düzeltmeleri. Herkese mutlu kodlamalar diliyorum.


Emir Buğra KÖKSALAN

Java & PHP Developer

0 yorum

Bir cevap yazın

Avatar placeholder

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir

Time limit is exhausted. Please reload the CAPTCHA.

This site uses Akismet to reduce spam. Learn how your comment data is processed.