Küçük geliştiriciler için kod incelemeleri gerekli midir?

Kod incelemelerine gelince, her biri farklı bir metodolojiye sahip olan iki şirkette çalıştım:

İlk şirkette ekip liderleri tarafından bir kod incelemesi yapıldı ve her modülün tamamlanmasından sonra talep edildi.

Ancak, ikinci şirkette, takım liderlerinin herhangi bir kod incelemesi yapması gerekmedi ve sadece işlevsellik ve tasarım sorunları için kontrol edildi.

Bu yüzden kafam karıştı. Kod inceleme süreci gerçekten gerekli mi? Öyleyse, neden? Ve değilse, neden olmasın?

Şahsen her kod parçasının bir kod incelemesinden geçmesi gerektiğini düşünüyorum, küçük veya kıdemli bir geliştirici olup olmanız önemli değil.

Neden? Yeni başlayanlar için unvanınız nasıl gelişiminizle ilgili hiçbir şey ifade etmiyor ve kıdemli bir geliştirici gençlerden bir şeyler öğrenebilir. Şirketimizde vardiya değiştiriyoruz, böylece ekibin diğer üyelerinden biri kodunuzu gözden geçiriyor ... çoğunlukla bir "genç" ve kıdemli bir ekip olarak birlikteyiz, bu nedenle günlük olarak söylenmeyen her şey olabilir. takipte yakalandı. Eğer yaşlılar gençlik kodunu beğenmiyorlarsa, gençlerin neden yaptıklarını dinlemeli ve ona bakmalı ve gelecekte kullanılabilecek uygun bir çözüm olup olmadığına bakmalı, önemli değil mi? sen kimsin.

Kod incelemeyle ilgili önemli bir şey çok iyi olmamaktır, eğer iyi bir adamsanız, daha fazla dağınık kodun sistemde gelişmesine izin vereceksiniz. Tıpkı dün olduğu gibi, eskiden çalışan genç bir geliştiricinin yazdığı tam bir başvuruyu yeniden işleme koymaya başladım ve tanrım o kodun ayrılmadan önce bir incelemeye ihtiyacı olabilirdi.

Neden sadece gözden geçirme yapan ekip lideri olması gerektiğini anlamıyorum, ancak zayıf gelişmiş kodun bir parçası üzerinde "kavga" etmekten korkmayan bir kişi gerekiyor ve kodun nasıl olması gerektiğine önem veren bir kişi olmalı. olmak. Tüm şirketler aslında ne yaptıklarını önemseyen insanları işe almazlar ve bu kötü yumurtaların IMO'ya kod incelemeleri yapmasına izin verilmemelidir, çünkü sadece omuzlarını silecek ve kötü kod için "Tamam" diyebileceklerdir.

Temel olarak, deneyimden bağımsız olarak tüm programcılar için kod incelemesi gereklidir. Yazılım geliştirmenin Kalite Kontrolüdür ve Açık Kaynak'ın çok yüksek kalitede olmasının sebeplerinden biridir.

EDIT: Bunun nedeni, bugün bir kod gözden geçiricisinin, daha sonra bir koruyucu ile tamamen aynı rolde olmasıdır. Eğer kod bugün ona bir şey ifade etmiyorsa, daha sonra da bir anlam ifade etmeyecek ve hataların düzeltilmesi daha pahalı olacaktır. Bu nedenle, geliştirici hala kodu hatırlarken, bugün anlaşılabilir hale getirin. Ayrıca gözden geçiren, geliştiricinin kaçırdığı hataları veya eksiklikleri görebilir.

Maalesef çok az kişi bunu yapmak istiyor, ancak iş açısından bakıldığında zorunlu olması gerekiyor.

Kod incelemesinin artık bir gereklilik olduğu, ancak 3 yıl kadar az olmadığı bir yerde çalışıyorum. Kodumuzda ve başkalarının kodu daha sonra muhafaza etmeleri konusunda büyük bir gelişme kaydetti. Kıdemli, çok deneyimli geliştiriciler bile, QA onları bulmadan önce kod incelemesinde kolayca ve sessizce düzeltilebilecek veya müşteri onları bulmadan daha da kötüye gidebilecek hatalar yapar. Ayrıca, orijinal geliştirici dışındaki en az bir kişi kodla uyumludur.

Genellikle bir kuruluş yeni bir şey denediğinde, kod incelemesinde yaptığımız gibi, değişime karşı çok fazla direnç vardır. Neredeyse hiçbiri görmedim (biz de resmi bir QA departmanı almak için estatiktik.) Kod incelemesi ile. Hemen hemen değeri görmek için bir veya iki inceleme alır.

Hem başkasının çalışmasının kod incelemesini yaparken ya da kodumun incelenmesini istemediğim yeni teknikler buldum. Kod incelemeleri yaparak ve daha da önemlisi kod incelemesine nasıl yanıt verdikleriyle yeni işe alımlarda yeterlilik problemlerini nispeten hızlı bir şekilde bulduk. Şu anda programlamanın tam anlamıyla net göründüğü şeyleri, bakım sırasında net olmayacak olan bu bölümü öğrendik. Bu paha biçilmezdir. Gereken tek şey, bir şeyin neden yapıldığıyla ilgili bir yorum olabilir. Bir raporun gerçekten doğru bilgiye sahip olması için düzeltilmesi gereken veritabanı tasarımımızla ilgili bazı yanlış anlaşılmalar bulduk.

Çoğunlukla bir kod incelemesinde gördüğüm şey, başkasına bir şeyler açıklamak suretiyle geliştiricinin kafasında bir ampul açacağının ve incelemecinin görmediği bir hata olduğunu fark edeceğidir.

Ve çocuk kod incelemesini, herhangi bir standardı takip etmeyen veya zorunlu araçları kullanmayan ve kuralları başkaları tarafından erişilemez duruma getirilemeyecek olan kovboy programcılarını tanımlayabilir. Ve onları programa girmeleri ya da dışarı çıkmaları için zorlayabilir.

Kod incelemesine en dirençli kişiler genellikle kurumun en çok kurtulması gereken kişilerdir çünkü yüreklerinde kodlarının kod incelemesini geçemediğini bilirler.

Çevik adam şöyle derdi: "Kod incelemesine gerek yok, sadece çift programlama yapın ve iyi testler yazın" :)

Kod gözden geçirme, bir takım aracılığıyla bilgiyi ve iyi uygulamayı yaymanın iyi bir yoludur. Tecrübelerime göre, tüm kodların gözden geçirildiğinden emin olmak ve kimin kodunu inceleyen değiştirmeye çalışmak iyi bir fikirdir.

Şu anki ekibimde herkesin kodu eşit olarak gözden geçirildi ve serbest bırakılmadan önce hem programcının hem de hakeminin kodu yerine getirmesi gerekiyor. Bu, üst düzey geliştiriciler için daha fazla küçük geliştirici, başka bir gözden geçiren küçük geliştirici veya birbirlerini gözden geçiren diğer üst düzey geliştiriciler tarafından da incelenir. Gözden geçiren kişi deneyimsizse veya belirli bir kod parçasını incelemekte rahat hissetmiyorsa, incelemeyi grup olarak yapmak için başka bir geliştirici (ve belki de orijinal geliştirici) ile birlikte çalışacaktır.

20 yıldan fazla bir süredir bu işteyim, yazılım şirketleri ve farklı işletmeler için çalışıyorum ve bu yerlerin hiçbiri kod inceleme sürecine girmedi. Ancak, sahip olmanın faydalarını anlayabilir ve takdir edebilirim. Temel olarak, onları anladığım gibi, gelecekte diğerlerine daha kolay bir şekilde kod koyabilmeleri için takip edilmesi gereken standartlara uyumu sağlamak için kullanılmaları gerekir. Kod okunabilirliği de bir inceleme sürecinde kontrol edilebilir, çünkü bu da bakımın kodla etkili bir şekilde çalışabilmesini sağlar.

Şu anda, tek geliştirici olduğum küçük bir mağazada çalışıyorum. Arada sırada birikimde yardımcı olmak için müteahhitleri getirdik. Bu yüklenicilerin en az bir veya ikisi, benim veya şirketlerin standartlarını mutlaka karşılamayan bir kod yazdı, ancak iyi çalıştı ve en azından bir şekilde anlaşılırdı. Bu konuyu yönetime gösterdiğimde umursamadılar, sadece onlara yapmaları için ödediklerimizi yapıp yapmadıklarını bilmek istediler. Bu nedenle, sadece şirkete bağlı olduğunu ve temiz olup olmadığına, kodun kolay yönetilmesinin istenen ürün olup olmadığına ya da para için iyi işleyen bir şey isteyip istemediklerini sanırım.

Açıkçası bir geliştirici olarak ve kodunu sürdürmek zorunda olan biri olarak, bir tür standardı izleyen temiz kodla çalışmak isterim, ancak her zaman bu lüksü kullanmıyorum, bu yüzden en iyisini yaparım ve sahip olduğum şeyle ilgilenirim. , bazen kendi kodumda bazı kodları tekrar yazmak zorunda kalmamıza rağmen.

Kod incelemeleri, sorunların çözülmesi daha kolay (ve daha ucuz) olduğunda yazılım yaşam döngüsünün başındaki hataları tanımlayabilir. At SmartBear biz geliştirdik akran kod incelemesi aracı ve ayrıca kod yorumları etkili hale getirmek için nasıl içine çok araştırma yapmış. Müşterilerimizden gelen verilere dayanarak, kod incelemesinde bulunan kusurlar, KG'de bulunan kusurlardan daha bulmak ve düzeltmek için 8-12X daha ucuzdur. Maliyet tasarrufları tek başına kod incelemesine değiyor, ancak bundan daha fazla değer var. Kod inceleme, ekipteki herkesin yazılım geliştiricileri olarak öğrenmesi ve geliştirmesi için mükemmel bir yoldur.

Kod incelemelerinin daha az etkili olmasına neden olabilecek bazı tuzaklar vardır ve kuruluşunuz bunlardan birinde kalıyor gibi görünmektedir. Kod hakkında insanlar hakkında kod incelemesi yapın. Başlıklar, kod incelemesinde hiçbir şey ifade etmez. Otoriteye itiraz (benim yolumuzu yapmalısınız çünkü takımın lideriyim) iyiden daha çok zarar vermek. Bunun yerine öğretin. Üst düzey mühendisler neden sadece yapılması gerektiğini değil, neden kendi yollarının yapılması gerektiğini açıklamalıdır. Bir kavramı açıklamakta zorlanıyorsanız, bu sizin için de bir öğrenme deneyimidir. İkiniz de harcadığınız çaba için daha iyi geliştiriciler olacaksınız.

TÜM KODU inceleyerek kod overkill olduğunu düşünüyorum. Tüm kodları gözden geçirmek için harcanan zaman başka bir yerde daha iyi harcanabilir. Alterntivley Kritik kodun ve özellikle karmaşık parçaların kod incelemeye ihtiyaç duyduğunu düşünüyorum, ancak kesinlikle her kod satırında değil.

Kanımca, bir şirket tarafından kullanılacak olan kod, ister Junior veya Senior geliştirici tarafından yazılmış olsun, her zaman gözden geçirilmelidir. Neden? Çünkü ya kodda birkaç hata varsa? Ve bu kod kullanılırken program çöktü ise ne olacak? Bunların olmasını engellemek için, kullanmadan önce tüm kodların gözden geçirilmesi gerekir.

Peki ya kodu gözden geçirmeyen şirketler? Muhtemelen çok fazla teknoloji problemi olan ve tüketicilere söyledikleri gibi "çökmeler" ;-).

Öyleyse tüm sorularına cevap vereyim:

• Evet Gözden Geçirme Süreci gereklidir.
• Neden? Yukarıda belirtilen nedenlerden dolayı.

Kod Gözden Geçirme : Kod Gözden Geçirme işlemi herkes için hayati öneme sahip olmalı , kod incelemesinin yürütülmesi nedeniyle kimlerin fayda göreceğini ve kazandıkları faydaların neler olduğunu açıklayacağım.

1. Kod İncelemesinin Yapılmasından Kaynaklanan Şirket Tarafından Sağlanan Faydalar: Sık sık kod incelemesi yapılırsa, şirket nihai ürünleri daha iyi optimize edilmiş bir şekilde elde edebilir ve bu sayede pazarlarında markalanmış bir isim almalarına yardımcı olur ve aynı zamanda şirketlerine yardımcı olur. mevcut CMMI seviyelerini almak veya geliştirmek .

2. Kod Gözden Geçirmesinin Yapılmasından Kaynaklanan Ekip Liderine Faydaları: Bir hepimizin bildiği gibi, öğretmen hataları kolayca tespit edebilir, çünkü öğrencilerin cevaplarını daha sık gözden geçirir, böylece hangi alanlarda olabilir? yanlış şeyler için mümkün olabilir. Benzer şekilde, takım lideri de bu alanlarda neyin yanlış gittiğini biliyor. Bunları nasıl düzeltebiliriz.Ve ayrıca küçük geliştiriciden haberleri almak için takım liderine de yardımcı olun.

3. Junior Developer'ın Kod İncelemesinin Yapılmasından Kaynaklanan Yararları: Junior Developer, Code Review Process ile ilgili fikirleri kolayca alabilir, ayrıca kodlama standardı olanı alabilirler, For Force: API'yi uygun bir şekilde oluşturmak için, Gelecekte özellikle Üst Düzey görevde olduklarında kendilerine yardımcı olabilecek kodlamanın standartlaştırılmasını öğreneceklerdir.

Sonuç olarak, Kod İnceleme, herkes için Çok Çok Önemli bir İşlemdir (hatta Ekip Üyesi için bile), çünkü Kod İnceleme kodumuzdaki dikkatsiz hatalarımızı düzeltmemize yardımcı olur, çünkü biz hepimiz insanız, bu yüzden asla Kodda dikkatsiz hatalar yapın.

Kodunuzu kontrol etmeden (gözden geçirme) veya daha sonra bir hatadan dolayı fikirlerinizi engellemenin, anlaşılması zor / anlaşılmaması veya kabul görmüş standart uygulamaları izlememenin farkı nedir? Senin egonun mu?

Saygı duymadığınız kalifiye bir ekip üyesi tarafından kötü bir şekilde uygulandığı için kod incelemesinin esasını veya başka bir şeyi göz ardı edemezsiniz. Kod İnceleme, yalnızca birkaç süper programcının kavrayabildiği oldukça karmaşık bir işlem değildir. Kendini düzenleme yeteneğine sahip veya zamanı olan birçok programcı veya profesyonel yazar olduğundan emin değilim.

Birkaç ay sonra bir kod satırına geri döndünüz ve ne düşündüğümü merak ettiniz mi? Kod incelemesiyle daha iyi bir yakalama şansı olurdu. Sadece onu yakaladın ve bir süre önce olduğun programcıdan biraz daha iyisin - Umarım.

IMO'nun kod incelemesi tüm geliştiriciler için şarttır, ancak incelemeyi yapan kişiler kendileri yetkin olduğunda. Geçmişte kodun incelenmesini reddetmiştim, çünkü sizi izlemedim SOLID, takip ettim , bir miktar Bağımlılık Enjeksiyonu yaptım ve kodun mantıksal tasarıma göre ad alanlarına ve klasörlere düzenlenmiş ve küçük bir birim test paketi içeriyordu. Kodu doğrulayın. Kod "çok karmaşık" olarak reddedildi ve her şeyi bir araya getiren ve testleri kaldıran bir sınıf kullanmam söylenmişti, çünkü şirketin kodu böyle yazmıyordu.

Bunun gibi bir kod incelemesi değersizdir, ancak yetkili bir ekiple yapılan bir kod incelemesi genellikle tasarım hakkında bir şeyler aydınlatabilir (örneğin, neden X ve Y yapmalısınız, ancak Z'yi yapmamalısınız) veya gerçek bir kusuru belirtin (örn. yanlış sebeplerden dolayı).

Elbette Kod İnceleme gerekli değildir . Sonra tekrar, testler, sürekli entegrasyon, kaynak kontrolü, müşteri katılımı, profilleme, statik analiz, uygun donanım, tek tıklamayla kurulumlar, hata izleme, liste devam ediyor.

Code Review ile birlikte, yukarıda bahsettiğim şeyler, yazılım kalitesinin korunmasına yardımcı olan araçlardır. Beceri, şans, zaman ve kararlılık kombinasyonu ile; Eğer yapabilirsiniz Bu eşyaların herhangi olmadan kaliteli yazılım teslim, ancak daha büyük olasılıkla sen işte olmaz .

Senaryoda, kafan karışacak bir şey yok. Her organizasyon en iyi uygulamalardan hoşlanmaz. Bununla aynı fikirde olmayabilirler, uyguladıkları farklı bir en iyi uygulama ile çatışabilirler ya da uygulama yükünün bu noktada onlar için çok büyük olduğunu düşünebilirler. Koşullarına bağlı olarak, bunu yaparken doğru olabilirler veya sahte bir ekonomi oluşturabilirler. Bazı araçlar için, (örneğin kaynak kontrolü) geri ödeme / efor oranı o kadar iyidir ki; diğerleri için daha az açık.

Kuşkusuz, kod incelemesinin önemli bir ek yük getiren bir uygulama olduğu şüphesizdir. Bu nedenle, kuruluşlar bu ek yükü en aza indirgemeyi ya hiç ya da sadece belirli durumlarda (örneğin küçük bir ekip üyesi ya da özellikle kıllı bir değişiklik için) yaparak en aza indirmeye çalışacaklar. Maliyetinden daha fazla geri kazandığı (böcekleri yakalamak, teknik borçları azaltmak veya bilgi paylaşmak) her zaman açık değildir. Bu geri ödemenin miktarını ölçmek zordur, oysa kuruluşunuzun incelemelerde harcadığı çalışma saatlerini saymak çok kolaydır. Ölçülmesi en kolay bit (azaltılmış hata sayısı) diğer faktörlere atfedilmesi kolaydır (örneğin, "tabii ki daha az böcek vardır, daha olgunlaşır").

Türkiye'de çevrimiçi futbol oyunu oynuyoruz. Pek çok kullanıcı ve oyun ustası bize işlevsellikte yardımcı oluyor. Ayrıca gerekli özellikler hakkında yorumlarda bulunurlar. Bu nedenle, çok fazla kullanıcınız varsa, yardımcı olmak veya rozet almak için işlevsellik testleri yapılabileceğini düşünüyorum. Geliştiricilerin, oyun ustalarının ve kullanıcıların forumlarla, destek ekipleriyle ve özel test ortamlarıyla işbirliği yapması bir sosyal proje oluşturur.

Kod gözden geçirme ve geliştirme ekibi arasında deneyimlerin paylaşılması gerekir ancak kritik önemde değilse, kendinizi zorlamanız gerekmez.

2. şahıs denetiminin ayrıntılı olmasının, yaşam çevrenize, daha çevik ya da süreçlerinizde daha fazla şelale olmasına bağlı olduğunu düşünüyorum. Üst seviye tasarım / inceleme yapmanın ve daha ayrıntılı seviye tasarım denetimlerinin yapılmasının makul olduğunu düşünüyorum. Ayrıca, incelemeye bir takımın birkaç üyesini dahil etmenin iyi olacağını düşünüyorum.

Çok az deneyime sahip oldukları için kesinlikle gereklidirler.