Merhaba Arakadaşlar Staj yapdığım yerde Projem İçin Comment (Yorum) Satırı Yazılması İstendi.Bunları Yapdım Staj Dosyamamda Comment'ın hakkıdna Biraz Bilgi Vermek İstiyorum Comment Nedir Nasıl Yazılır Yazarken nelere Dikkat Edilir yarımcı Olabilecek Birisi Varmı Acaba Bilgilendirirse çok makbule geçer :)
Comment Nedir Nasıl Yazılır ?
Cevaplar
OnurSorhan Konuyu açan
Comment kodun okunabilirliği için en önemli araçlardan birisidir.OnurSorhan dedi: ↑Merhaba Arakadaşlar Staj yapdığım yerde Projem İçin Comment (Yorum) Satırı Yazılması İstendi.Bunları Yapdım Staj Dosyamamda Comment'ın hakkıdna Biraz Bilgi Vermek İstiyorum Comment Nedir Nasıl Yazılır Yazarken nelere Dikkat Edilir yarımcı Olabilecek Birisi Varmı Acaba Bilgilendirirse çok makbule geçer :)
Ayrıca bazı araçlar bu comment'leri okuyarak otomatik help dosyaları vs. oluşturabiliyorlar.
Comment yazarken en önemli şey, ısrarla aynı şablonu kullanabilmek. Zaman içersinde boş comment'ler, copy-paste ile ilgisiz yerlerde ilgisiz yorumlar içeriğin bütünlüğünü ve doğruluğunu bozabiliyor.
Değişiklikleri comment'liyorsanız, tarih, değişikliği gerçekleştiren ve referans olabililecek bir ticket (servis) kaydı, değişiklik talebi numarası (BR veya change request) number önemli.