Kod İncelemesinin amacı nedir?

Kuruluşumu kod incelemelerinin değeri konusunda satmaya çalışıyorum. Çalıştığı çeşitli yerlerde çalıştım. Onları şekillendirme seçimlerini ve fonksiyonel kararları nitelemek için kullandıklarını gördüm ve bunların tehlikeli hiçbir şeyin uygulanmamasını sağlamak için bir bağırsak kontrolünden başka bir şey olarak kullanılmadıklarını gördüm. İçimdeki his, en etkili amacın iki seçenek arasında bir yerde olmasıdır.

Peki bir Kod İncelemenin amacı nedir?

Kod incelemesi yapmak istemenizin birçok nedeni vardır:

• Diğer geliştiricilerin eğitimi. Yazılımın geri kalanını anlayabilmeleri için herkesin bir kusur düzeltme veya geliştirme ile ilişkili değişikliği gördüğünden emin olun. Bu, özellikle insanlar entegre edilmesi gereken bileşenler üzerinde veya bir kişinin belirli modüllere bakmadan uzun süre boyunca gidebileceği karmaşık sistemlerde çalışırken faydalıdır.
• Gelişme için kusurları veya fırsatları bulma. Hem teslim edilebilir kod hem de test kodu ve veriler zayıflıkları bulmak için incelenebilir. Bu, test kodunun sağlam ve geçerli olmasını ve tasarım ve uygulamanın uygulama genelinde tutarlı olmasını sağlar. Ek değişiklikler yapılması gerekiyorsa, giriş noktasına daha yakın bir fırsat yakalar.

Gözden geçirmenin yapılması için birkaç iş vakası vardır:

• Enjeksiyonlarına daha yakın bir şekilde tekrar işlenmesi gereken hataları veya sorunları bulmak. Bu daha ucuz.
• Sistem ve karşılıklı eğitimin paylaşılması. Bir geliştiricinin değişiklik yapma hızını arttırması için daha az zaman.
• Sistemdeki olası iyileştirmelerin belirlenmesi.
• Test cihazlarının yeterli kapsama alanı sağladığından emin olmak için uygulamayı başlatmak. Siyah bir kutuyu test perspektifinden gri bir kutuya veya beyaz bir kutuya dönüştürme.

Akran değerlendirmeleri için faydaları ve uygulama stratejileri hakkında kapsamlı bir tartışma arıyorsanız , Yazılımdaki Akran Değerlendirmelerini: Karl Wiegers'ın Pratik Rehberini incelemenizi tavsiye ederim .

Kod Değerlendirmeleri bilgi aktarımı için bir araçtır .

• Geliştiriciler birbirlerinin kodlarını incelediklerinde, sistemin tüm alanlarında aşinalık kazanırlar. Bu, projenin veri yolu faktörünü azaltır ve geliştiricilerin yazmadıkları sistemin bir kısmını bakım yapmak zorunda kaldıklarında daha verimli hale getirir.

• Bir küçük programcı, bir kıdemli öğrencinin kodunu incelediğinde, küçük programcı, aksi takdirde yalnızca deneyim yoluyla öğrenilen püf noktaları alabilir. Bu ayrıca aşırı karmaşık kodlara karşı düzeltici olarak da çalışabilir.

  Kapsamlı bir kod incelemesi, çeşitli belgelere karşı sık sık kontrol yapılmasını gerektirir. Bir dil veya API öğrenmek için harika bir yol.

• Üst düzey bir programcı bir gencin kodunu gözden geçirdiğinde, bu sorunları teknik borçlara dönüştürmeden önce sorunları çözmek için bir fırsattır . Bir kod incelemesi, genç programcılara danışmanlık yapmak için iyi bir ortam olabilir.

Kod incelemeleri hakkında değil:

• … Böcek bulmak. Testler bunun için var. Yine de, sık sık bir kod incelemesinin bazı problemler bulması halinde ortaya çıkacaktır.

• … Stil konularını nitelendirmek - bir stil için yerleşmek ve bunu uygulamak için otomatik formatlayıcılar kullanmak. Ancak otomatik bir aracın kontrol edemediği birçok şey var. Kod incelemeleri, kodun yeterince belgelendiğinden veya kendiliğinden belgelendiğinden emin olmak için iyi bir yerdir.

Şahsen kod incelemesinden elde ettiğim en değerli şey, kodun başka bir kişi tarafından anlaşılacağı konusunda güvende olmasıdır . Değişkenler açıkça adlandırılmış mı? Her kod grubunun amacı oldukça açık mı? Bir yorumda belirsiz bir şey var mı? Son durumlarda ve parametrelerde geçerli değerler yorumlarda ana hatlarıyla belirtilmiş ve kod içinde kontrol edilmiş mi?

Diğer harika cevaplar tarafından kapsanmayan iki alan eklemek istiyorum:

Kod incelemelerinin büyük sebeplerinden biri , bizim durumumuzda aşağıdakilere çevrilen Hawthorne etkisidir : Eğer birisinin daha sonra kodunuza bakacağını biliyorsanız, o zaman daha iyi yazmanız daha olasıdır.

Bir başka büyük neden daha iyi güvenli geliştirme uygulamaları için. Bir kişinin güvenli bir geliştirme yaşam döngüsünde uygun kod incelemelerinin önemini anlamak için yalnızca Apple’ın goto başarısızlığına (yanlışlıkla kopyalanmış bir kod satırı) veya Heartbleed böcekine (giriş doğrulamasında temel bir başarısızlık ) bakması gerekir .