Kodunuza yorum yazıyor musunuz? Yapıyorsanız, bu harika ve yapmıyorsanız hemen yorum eklemeye başlayın. Kod basit bir standart kod ise veya her gün yazdığınız bazı standart şeyler olduğunda içerisine yorum yazmazdım. Ancak karmaşık bir mantık, bir koşul veya koşullar grubuysa, o zaman yorumlar gerçekten gereklilik haline geliyor.
Örnek iyi bir yorum:
//yorum olup olmadığını kontrol eder ve varsa bir teşekkür mesajı verir.
function sourceCodeComment (){
var comment = document.getElementbyID("Code Comment").value;
if (comment != null && comment != ''){
return console.log("Yorumunuz için teşekkürler.")
}Örnek gereksiz ve kötü bir yorum:
function sourceCodeComment (){//fonskiyonu çağırır
var comment = document.getElementbyID("Code Comment").value; // bir değişken bildirir
if (comment != null && comment != ''){ //yorum olup olmadığını değerlendirmek için bir if başlatır
return console.log("Yorumunuz için teşekkürler.") //dizeyi konsola yazdırır
}Kod içerisinde oldukça komik yorumlarla da karşılaşabiliyoruz ancak gereksiz yorumlardan kaçınmak ve olabildiğince iyi yorumlar yazmak herkes için, sizin ve sizden sonra kodu inceleyecekler için faydalı olacaktır.
Yorumlarda ne yazmalı?
Kod içerisinde bir yerlere yorum eklerken; şu iki soruyu yanıtlamaya çalışın: Ne ve Neden? Şu anda ne yapıyorsunuz, şu anki görevinizin adı nedir? Bu mantığı neden ekliyorsunuz? Sorun nedir ve buna çözümünüz nedir?
Ve son olarak, bunu yalnızca sizin için değil, gelecekte aynı kod üzerinde çalışabilecek diğer herkes için faydalı hale getirmeye çalışın.
Kodlu yorumlar hayatınızı kolaylaştırdığında deneyimlerinizi benimle paylaşın.
İyi kodlamalar!