Hata düzeltme yorumlarını kod içinde tutmak iyi mi?

Ekibim sürüm kontrolü olarak clear-case kullanıyor. Çalıştığım proje 7-8 yıl önce başlamıyor. Projenin tüm ömrü boyunca çeşitli hata düzeltmeleri hizmet paketleri vb. Yayınladık. Sorunlar, hata izleme sistemi kullanılarak izlenir ve hata düzeltmeleri üzerinde çalışan kişilerin çoğu, START / Tarih, yazar, hata kimliği vb.İLE END bloğu.

Bunun oldukça alakasız olduğunu ve kodun dağınık ve huzursuz olmasını sağladıklarını ve iş ürününün ek yaşam döngüsü bilgilerini tutabileceğimiz check-in yorumlarının / etiketlerinin vb.

Takip edilecek en iyi uygulama nedir?

Kodun bazı yorumcuları hata hakkındaki yorumları ısrar ediyor ve hayatlarını kolaylaştırmak için düzeltmeler yapıyor. Anladığım kadarıyla, dosyaları bir görünüme eşleyerek gözden geçirmeli ve dalın değişiklik günlüğünü almalı ve gözden geçirmelidirler. Güncellenmiş kodu incelenmek üzere göndermeyle ilgili en iyi uygulamaları edinebilirsem faydalı olabilir.

Hata düzeltmesini koda yorum olarak eklemeyle ilgili sorun, hikayenin tamamını alamamanızdır. "Bu hata blah bir düzeltme" etiketli mükemmel bir kod parçası görürsem , ilk tepki "ne yani?" Demek olacaktır. Kod orada, işe yarıyor. Kodu korumak için bilmem gereken tek şey bana ne yaptığını söyleyen bir yorum.

Daha iyi bir uygulama, SCM taahhüt günlüklerine hata düzeltme referansları eklemek olacaktır. Bu şekilde, hatanın ne olduğunu, nerede tanıtıldığını ve nasıl düzeltildiğini görürsünüz. Ayrıca, bir yayınlama zamanı geldiğinde, SCM günlüklerini kolayca ayıklayabilir ve bir hata olduğunu belirten bir madde işareti ekleyebilirsiniz ve bu hata düzeltildi. Başka bir şube veya sürüm aynı hatayı tanıtırsa, düzeltmeyi bulmak ve gerçekten aynı şeyse yeniden uygulamak kolaydır.

Bütün bunları söyledikten sonra Charles'ın cevabına da katılıyorum. Bir kod parçasının nedeni açık değilse, elbette, bakıcıya kodun bir nedenden dolayı orada olduğunu ve dikkatle ele alınması gerektiğini söyleyin.

Çoğunlukla kötü uygulama. Asla yapılmaması gerektiğini söylemeyeceğim. Bazen, harici bir API'de etrafta çalışmanız gereken bir hata gibi bir şeyle karşılaşırsınız. Altta yatan böcek hakkında bilmiyorsanız, etrafı saran beyin tamamen ölü gibi görünebilir. Bu durumda, koddaki hatayı belgelemek iyi bir fikir olabilir, bu nedenle iş arkadaşlarınız veya daha sonra kendiniz açık bir şekilde beyin ölü kodunu "düzeltmeye" çalışmaz.

Kötü uygulama. Yorumlar güncelliğini yitirecek ve kodları karıştıracak. Bilgiler, gerekirse, SCC sisteminizin sürüm geçmişinde hala mevcuttur.

Kulağa kötü bir uygulama gibi geliyor. Kuruluşunuz başka bir hata izleme sistemine geçmeye karar verirse ne olur? Ürününüzü şu anda kullanmakta olduğunuz aletlere çok sıkı bağlamayın. Belirli hata kimliklerine başvurmak yerine ve kodun neden göründüğünün nedenleri belirsizdir, tasarım kararınızı koddaki yorumlarla motive edin.

İlk tepkim, kendinizi tekrar etmeyin, bu yüzden onu koddan çıkarın ve SCM günlüklerine alın. Burada, işlevler için düzeltme yorumu, yazar adları ve dosyalar ve işlevler için oluşturma tarihleri ​​hakkında benzer bir tartışma yaptık. Geçmişte (SCM kullanılmadan önce) tüm bu bilgiler bir dosyanın evrimini yeniden inşa edebilmek için dosyalarda tutuldu.

Geliştiricilerin yaklaşık yarısı, bu bilgilerin tüm bilgileri tek bir yerde bulundurmasını istiyor (bu, SCM'deki değişiklikleri aramalarını tetikliyor). Geliştiricilerin diğer yarısı, kozada neyin değiştiğine dair ipuçlarını aramaya başlamıyor, ancak SCM'den kodda bilgiye ihtiyaç duymuyorlar. Bu yorumlarla ne yapacağımıza henüz karar vermedik. Bu, insanların çalışma şekline bağlıdır ve bazı insanlar bilinen yöntemlerini bırakma konusunda çok inatçıdır. Kod bloğunu yorumlamak ve onları sonsuza dek kodda bırakmak hakkında aynı şey.

Sadece Dyaster ve ark. JIRA'nın hata düzeltmeleriyle ilgili değişiklikleri görüntülemek için gerçekten güzel yetenekleri olmasına rağmen, bir hata düzeltmesini belgelemek için mutlak en iyi yer bir test durumundadır. Hangi hatanın giderildiğini belirten bir yorum yapılmadan kod net değilse, bu "kod kokusu" dur. Bununla birlikte, kokuyu temizlemek için zamanınız yoksa, yorum test koduna atıfta bulunmalıdır, burada kodun yaptığı şeyi neden yaptığını çok daha açık olmalıdır. Hata düzeltmesini açıklayan bir test vakası yazmak için vaktiniz yoksa, hata henüz düzeltilmedi, sadece ertelendi.

Ben kodun kendisi değil, taahhüt mesajlarda bugfix kimlikleri eklemeyi kabul ediyorum. Hata kimlikleri için işleme iletilerini otomatik olarak kazıyan hata izleyiciler çok kullanışlıdır.

Ayrıca, bu yorumları değiştirmenize yardımcı olması için sürüm kontrol sisteminizin suçlama / açıklama / övgü komutunu kullanabilirsiniz . Sonra, şöyle bir şey çalıştırdığınızda:

vcs blame file.ext

genellikle her satırı kimin değiştirdiğini, değiştirdiklerinde ve taahhüt kimliğini içeren yararlı bilgiler görebilirsiniz. Tamamlama kimliğinden, hata kimliğini içermesi gereken tam iletiyi alabilirsiniz.

İyi VCS sistemleri, bir satırı kimin değiştirdiğini hesaplarken boşlukları yok saymanıza izin verir.

Clear Case'in bu özellik için ne olduğunu bilmiyorum.