Pek çok genel alanda yorum yapma eğilimindeyim ve her tür farklı şekilde ele alınabilir.
Gerekli değişiklikler. Bunlar, kodun fonksiyonel gereksinimleri karşılamadığını veya çalışmadığını ve üretime itilmeden önce düzeltilmesi gerektiğini belirttiğim değişiklikler. Bu yorumlarda çok açık sözlü davranıyorum. Gereksinimler diyor ki ..., bunu yapmaz. Veya gönderilen değer boşsa (özellikle de gönderilecek verilere dayanarak bu davanın gerçekleşeceğini biliyorsanız) bu başarısız olur.
Sonra "bu işe yarar ama burada bunu başarmanın daha iyi bir yolu var" yorumları var. Bunlarda daha nazik olmalısınız ve daha fazla satış konuşması yapmalısınız. Daha iyi performans olması muhtemel olduğu için bunun yerine bunu söyleyebilirim (genellikle performans çok önemli olduğu SQL kodunu gözden geçirin). Stack Overflow'daki bir soruyu yanıtlarken yaptığım gibi neden daha iyi bir seçim olduğu hakkında bazı ayrıntılar ekleyebilirim. Bu özel kod için bu değiştirmek gerekmez, ancak gelecekteki kodlama değişikliği düşünün işaret edebilir. Temel olarak bu tür yorumlarla neyin daha iyi çalışabileceği konusunda daha az deneyime sahip insanları eğitiyorum.
Sonra "bu işe yarıyor ama işleri bu şekilde yapıyoruz" yorumları var. Bunlar muhtemelen gerekli değişiklikler olacaktır. Bunlar, şirket standartları veya kullanılmasını beklediğimiz mimari hakkında yorumları içerir. Standart veya mimari belgeye referansta bulunup, standarda düzeltmelerini söylerdim. Yorum basit ama tarafsız olacaktır, bu nedenle eksiktir ve bu nedenle değişken isimleri, adlandırma standardımız veya simliar şeylerimize uymuyor. Örneğin, SSIS paketleri mimarimiz, paketin paketle ilgili belirli bilgileri depolamak için meta veri veritabanımızı kullanmasını gerektirir ve belirli bir günlük kaydı gerektirir. Paket bu şeyler olmadan çalışır, ancak şirket nedenleriyle gereklidir (örneğin, ithalatın başarı oranını raporlamamız veya aldığımız hata türlerini analiz etmemiz gerekir).
Kod inceleme yorumlarında yapmak istemediğiniz tek şey, birisine kişisel olarak saldırmaktır. Ayrıca, iyi bir şey bulduklarını ve bunun iyi olduğunu belirttiğinizde de yardımcı olabilir. Bazen bir kod incelemesinden yeni bir şey öğrenirim ve eğer öyleyse kişiye bunu söylerim.