Başka bir ekibin kodunun yeniden yazılmamış kuralları [kapalı]

Toplu kod sahipliği uyguluyoruz. Anladığım kadarıyla bu, herhangi bir geliştiricinin işlevsellik eklemek, yeniden yansıtmak, hataları düzeltmek veya tasarımları iyileştirmek için herhangi bir kod satırını değiştirebileceği anlamına geliyor.

Ancak, hala ekipte olan bir geliştiriciden kodun tamamen yeniden yazılmasına ne dersiniz? Önce ona sormalı mıyım? En iyi uygulama nedir?

Bence iyi iletişim her zaman en iyi yöntemdir. Geliştirici ile konuşun ve olduğu gibi kodlanmasının bir nedeni olup olmadığını görün. Yaşları boyunca geri dönüp yeniden düşünmek anlamını taşıyor olabilirler, çok iyi bir nedenden ötürü bu şekilde yapmış olabilirler ya da her ikinizden de konuşmanızdan bir şeyler öğrenmiş olabilirsiniz.

Önceden iletişim olmadan içeri girmek ve yeniden yazmak, kötü niyet için bir reçetedir.

Bu sorunun temeli, benim için mevcut cevapların hiçbirinin uygun bir şekilde ele almaya çalıştığını düşünmediğim için bir takım endişeler uyandırıyor. Buraya birkaç soru sorayım:

1. Yeniden yazma hakkında konuştuğunuzdan ve yeniden düzenlemekten değil, kesinlikle olumlu bir şekilde emin misiniz? Tanım gereği, harici davranışta herhangi bir değişiklik yapılmaksızın geliştirilmiş (veya yalnızca farklı) bir uygulamaya neden olan kod stilinde veya yapısındaki değişiklikler, yeniden yazma değil , yeniden yapılanmadır . Monolitik bir 500-satırlı rutini 50 alt rutinden oluşan bir kümeye bölmek, bir miktar yeni kod yazmayı içerebilir, ancak bu bir yeniden yazma değildir. Yeniden yazma terimi, bütün bir ürünün veya özelliğin atılmasını ve sıfırdan başlamayı ifade eder; hafifçe alınacak bir şey değil.

2. Orijinal kodun davranışı çok yanlışsa veya uygulama tam teşekküllü bir yeniden yazma gerektirecek kadar zorluysa, neden ekibinizin süreci tarafından yakalanmadı ve uygun bağlamında ele alınmadı (yani teknik olarak sosyal olarak)? Kötü ya da sorgulanabilir kodlar testler, kod incelemeleri, tasarım incelemeleri vb. Yoluyla sağlıklı bir takıma hızla maruz kalmalıdır. Bunlara sahip misiniz?

3. Yönetici / teknoloji lideri sorunun farkında mı ve değilse de neden olmasın? Ne tür bir sürece sahip olursanız olun, kod kalitesi normal olarak geliştirme yöneticisinin sorumluluğundadır. O, sormanız gereken ilk kişidir - açıkçası "ve böylece kod kodunu yazdı" bağlamında değil, sadece "Burada büyük bir sorun görüyorum, yeniden yazma hakkında konuşabilir miyiz?" Bu tür bir tartışmayı garanti etmiyorsa, o zaman belki de tekrar yazmaya gerek kalmaz mı?

4. Eğer suç işleyen kodun büyüklüğü ve kapsamı, yeniden yazma hakkında ciddi bir tartışma yapılmasını sağlayacak kadar büyükse, neden sadece bir geliştiriciye aittir ? Çoğu zaman kod gördüğümde ve "yeniden yazma" düştüğümde, bir düzine farklı insan tarafından ezilmiş olsaydı ve kötülük, tarz tutarsızlıklarının, yanlış veya değiştirilmiş varsayımların ve iyi eskilerin birikiminin doğrudan bir sonucudur. moda kesilmiş hackler. Kod , paylaşılan mülkiyeti nedeniyle tam olarak zaman içinde dikenler büyür .

   Burada demek istediğim, bir kişinin kolektif mülkiyeti uygulayan bir ortamda böylesine büyük bir kod alanına sahip olması garip. Diğer insanlar bu geliştiricinin koduna dokunmaktan korkuyor mu? Konuyu gündeme getirmekten korkuyorlar mı? Belki grubunuzun dinamiği veya özel olarak bu geliştirici ile ilgili temel bir problem var; eğer varsa, görmezden gelme. Veya alternatif olarak, belki de öyle sizin ilk kez bu proje üzerinde çalışan ve eğer öyleyse, neden olan sen bu kadar erken oyunda bir yeniden yazma düşünmeye? Durumla ilgili bir şey benim için bir şey ifade ediyor gibi görünmüyor.

5. Soru, ilk paragrafta belirtmektedir any developer can change any line of code to add functionality, to refactor, fix bugs or improve designs. Bir yeniden yazma Will değil bunları yapmak? Yoksa ekstra bir şey mi yapacak - ve eğer öyleyse, ne? Temelde ne olduğu yeniden yazmak yapmak isteyen için nedenleri ve onlar ürün veya ekip faydalarını göreceksiniz ne kadar eminiz? Bana cevap vermene gerek yok, ama bunu takımla tartışmayı seçip seçmeyeceğine karar vermen iyi olur.

Gerçekten bu soru bağlamında büyük miktarda gerektirir ve gerektiği hissetmek değil bu bağlamda bir çok net anlamadan cevaplanması. Tamamen "doğru" cevap, ekibinize, ürününüze, kuruluşunuza, kişiliğinize, sürecinize, orijinal kodun kapsamına, değişikliklerin kapsamına vb. Bağlıdır. Bu, IMO, çevrimiçi bir soru-cevap sitesi üzerinde değil, ekibinizle kesinlikle ilgilenmeniz gereken bir konudur .

Neden kodu düzenliyorsun?

Hatalar var mı yoksa daha temel bir tasarım hatası mı?

Eski durumda, koddaki ufak hataların neler olabileceğini düzeltmek için yeniden yazma konusunda endişeliydim.

İkinci durumda, "benim" kodumun potansiyel olarak yeniden yazıldığına dair bir destek beklerken, bunun gerçekleşmesi için tamamen mutlu olurum.

Bu, kolektif kod sahipliğinin amacı - yazdığınız kod, daha iyi bir şey olursa bile değiştirilecek veya değiştirilecek.

Genel olarak, hepiniz koddan sorumlu olduğunuzu kabul ederseniz, bir iyileştirme varsa herhangi bir kodu yeniden yazmak sorun değil. Bunu diğer geliştirici ile ilk önce nezaket olarak tartışın. Belli bir şekilde yazılmasının geçerli sebepleri olabilir. Kişisel düzeyde, birçok geliştirici ürettikleri üretime duygusal olarak yatırım yapar ve başkalarının söylediği gibi hiçbir hasta isteğini istemezsiniz.

Özellikle, takım dinamikleri biraz bağlıdır. Küçük bir geliştiricinin kodunu yeniden yazmak üzere olan üst düzey bir geliştirici, basitçe yeniden yazmadan önce muhtemelen bir kod incelemesi yapmalı (sitem). Bu şekilde genç geliştirici durumdan öğrenebilir.

Orijinal geliştiricinin takımda olup olmadığı ya da orijinal geliştirici olsanız bile önemi yoktur. Tam yeniden yazma herhangi paylaşılan kod aşağıdaki nedenlerle, sizin ekip tarafından çalıştırılması gerekir:

• Önemli miktarda zaman alır. Başka biri ilgili bir değişiklik üzerinde çalışıyorsa, zamanını boşa harcamak istemezsiniz.
• Diğer insanların farklı bir bakış açısı var. 20 yıl boyunca programlama yapmış olsanız bile, başka biri nadiren dokunduğunuz kodla etkileşimler hakkında bir şeyler biliyor olabilir.
• Diğer geliştiriciler kaynak kodun "müşterisi" dir. Kaynak kodu, diğer geliştiricilerin okuması için yazılır. Mimari gereklilikleri, stil girişleri veya bu kodda istedikleri ancak zaman bulamadıkları özellik istekleri olabilir. Bir refaktörü bitirmek istemezsiniz, sadece farklı bir şekilde refaktöre ihtiyacı olan başka bir geliştiricinin ihtiyaçlarını bulmak için.

Matthew Flynn'in dediği gibi, önce geliştiriciyle konuşmak gerekir. İlk geliştirici, işlevsellik hakkında önemli şeyler söyleyebilir ve neden ya da bu çözümün verildiğini açıklayabilir.

Ancak kodu yeniden gözden geçirmeden veya yeniden yazmadan önce, bu kodu içeren bir yedekleme veya dallama yapın. Eski kod düzgün çalışırsa, geri kazanılması için bir şans kalır.

Eğer bir kaynak kontrol sisteminiz varsa (ki sanırım varsa), o zaman mümkünse kodun tamamını yeniden gözden geçirin ve daha sonra, iyi çalıştığından emin olduğunuzda, kontrol edin.

Eski kodu silmeyin, en azından yeni kodun iyi çalıştığından emin olmadan önce. Fakat eski kodu sonsuza dek orada bırakmak da iyi bir şey değil. Kodu bir süre sonra silmenizi öneririz, testten sonraki bir ay içinde olduğu gibi.

Kapsamı nedir?

• Daha verimli olması için birkaç çizgiyi elden geçiriyorsanız, sadece yapın. Belki ince davranışınızı silmeniz için bir tehlike olup olmadığını sorun. Gerçekten önemsiz olmadığı sürece (yazım hatası düzeltme) yapılmadığında, değişiklik sırasında veya e-posta yoluyla yapılan değişikliği bildirin.

• Düzgün boyutta bir sınıfı elden geçiriyorsanız, muhtemelen tasarım / davranışı anladığınızdan emin olun. İnsanların vaktinden önce haberdar etmelerini sağlayın, böylece aynı alanda çalışan herkes sizinle tanışıp onlarla koordine olabilir.

• Daha büyük bir sistemi elden geçiriyorsanız, değişikliklerden haberdar olmaları ve tasarımı planlamaları için kesinlikle ekibinizle birlikte çalışmalısınız.

Orijinal yazarlarınız oradaysa, onlarla iletişim kurun. Susturulmuş için SADECE değil, ancak bilmediğiniz durumlar veya durumlar olması durumunda ek bilgi için. Bazen size değerli bir şey söylerler.

Çok fazla kod kontrolümüz var. Şu anda inceleme ve bakım gerektiren bir sürü işim var ve kod incelemesi yapacak hiç kimsem bile yok. Önceki yazarlar (moi dışında) herhangi bir kodu yorumlama zahmetine girmediler. Ve şirketten gittiler. Kod hakkında sorulacak kimse yok.

Tekrar yazdığımda, yorumladığım yorumların yanı sıra tarih ve ad / ilk harflerin yanı sıra neden yorumlandığını da yorumluyorum. Yeni kod, isim veya harflerle, tarih, sebep eklenmiş vs.

Paket başlığında (genellikle er) hangi fonksiyonların / procs / SQL / etc olduğunu gösteren ek yorumlar yapılır. tarih ile değiştirildi. Değiştirilen bölümleri aramayı kolaylaştırır ve bu bölümlerin tam belgeleri vardır.

Yorumlar ucuz. Tarihler, neyin değiştiğinin bir göstergesi olacak ve x sayısının (gün / revizyon / yeni işe alım / emekli) sayısından sonra kod eski yorumlardan temizlenebilir ve geri kalanı yeni başlangıçtır.

Gözlemlerime göre genel uygulama: Kodu asla silmeyin. Sadece yorum yapın ve saklayın.

Benim pratiğim değiştirirken yorum yapmak. (Genellikle referans için.) Sonra çalışma değişikliğinin son taahhüdünde silin. (Bu sürüm kontrolü ve değişikliklerin nasıl geri alınacağına dair bir anlayış gerektirir.)

Eski yorumlanmış kodu bulduğumda, uygun yorumlarla ayrı bir işleme koymaya çalışıyorum. Bu, gerektiğinde değişimin geri alınmasını veya denetlenmesini kolaylaştırır.

Tüm değişiklikler için, kodu oluşturan geliştiriciyi belirlemek için düzeltme geçmişini kullanabilmelisiniz. (Açıklamalı revizyon geçmişi burada yardımcı olur.) Kodun neden olduğunu görmek için mümkünse onlarla iletişim kurun. Birçok projede, temizleme zamanı gerçekleşmez ve işler geride kalır. Gerekli temizleme kaydının olup olmadığını görmek için hata izleyiciyi kontrol edin. Bazen değişiklikler bir ya da iki kez serbest bırakılmalı.

Kod değiştiriyorsanız, bu kodla çalışmanızın bir nedeni olmalıdır. Kodun neden böyle olduğunu öğrenmek için orijinal geliştiriciye danışın. Düzeltmemenin meşru bir nedeni varsa, neden düzeltilmediğini veya neden değiştirilmemesi gerektiğini açıklayan bir yorum ekleyin. Bu, bir sonraki geliştiriciye biraz zaman kazandıracak.

FixMe, ToDo, Bug ve Hack gibi etiketler daha sonra değiştirilebilecek kodu belirtmek için kullanılabilir. (Sınırlamaları Bug olarak etiketlemek ve gerekli koşullar altında tetiklenmemeleri durumunda bunları düzeltmemeleri kabul edilebilir.) Bir ev muhasebe programı 20 milyon dolardan fazla taşarsa hata olabilir, ancak fazla zaman harcamak istemem o.

Kodun değiştirilmesi uygunsa, kod inceleme değişiklikleri orijinal geliştirici tarafından yapılmalıdır.

Muhtemelen yeniden yazma neden gerekli olduğuna bağlıdır. Bunun sebebi, yazılanlarla ilgili sorunlar olması ve bununla ilgili her zaman bir sorun olması durumunda, gelecekte kodun ne kadar sıklıkta düzeltilmesi gerektiğini en aza indirmek için, bunun hakkında konuşmak çağrılır.

Bu durumda benim önerim , kodu tamir ederken eşleştirmek. Bu şekilde, ara durumların iyi bir örneğini ve (umarım), yeniden yazılmış kodun neden daha iyi olduğuna ilişkin bir bağlam sunar . Ayrıca (yalnızca kişisel bir alıştırma olarak), kodu yeniden yazmadan daha iyi olmak için yeniden düzenlemeyi deneyin. Daha zor olacak, ama senin için iyi.

Öte yandan, bir yeniden yazmanın çağrıldığı bazı durumlar vardır:

• Takım kod yazıldığından beri çok şey öğrendi ve yazdıran kişi / yazarlar, girişiniz olmasa bile, şimdi farklı şekilde yazacaklardı.

• Yeni bir özellik gereksinimi, durumu hedefli bir mini-yeniden yazma uygun olacak şekilde değiştirir.

Bu gibi durumlarda, muhtemelen bir konuşma ile rahatsız olmaz.

Bunu düşününce, bana kodun ne kadar uzun sürdüğünü, konuşma olasılığının daha düşük olduğunu düşünüyorum.

Sanırım @aaronaught bazı cevaplar verdi ki bu gerçekten vermek istediğim cevaba yol açtı, bu gerçekten de değişikliği kimin yaptığına (ve neden) ve kodu kimin yazdığına bağlı.

Kişisel deneyim kodumda normalde değiştirildi, çünkü ya amaçlandığı gibi çalışmıyor ya da aslında ne yaptığını genişletmeniz gerekiyor.

Team dev ortamında, orijinal kodlayıcıyla konuşmamalısınız (ve mümkün olmayabilir), her şey koddan açıkça anlaşılmalıdır.

Bu daha sonra zamanımın çoğunu tüketen, orijinal programcının neyi amaçladığı ve neden çoğu zaman kodun silinmesine yol açan soru olduğu ve neden her şeyi yorumlamamız gerektiği ve deneyimsiz genç programcıların en fazla olduğu soruya yol açar. Genellikle faul düşer.

Başkasının kodunu değiştiren (yeniden düzenleyen) herhangi bir programcının, nezaket ve uygulamada olması gerektiği gibi, aynı kodun kodlama stilini zaten kopyalaması gerekir ve ilk önce orijinal kodun nasıl çalıştığını ve ne denediğini anlamak için gerekli adımları atın. Ve, aslında başaracağım. Genellikle bu başlı başına hataları tanımlar, ancak kesinlikle insanları bir sonraki kişinin kodunuza bakacakları acıya katlanmaya zorlar.

Ekibimde herkes bir şeyi silebilir, yeniden düzenleyebilir veya yeniden yazabilir ve 'mülkiyeti' tembelliği besleyen bir uygulama olarak görüyorum, sanki bir kişi herhangi bir değişiklikten haberdar edileceğinden emin gibi, neden kodu okunaklı hale getirmeleri gerekiyor?

Kısacası hayır, kodun asıl yazarına sormanız gerekmemeli ve yaptığınız koda bakıldığında, ya kodunun yeterince okunamayacağının ya da iyileştirmeniz gerektiğinin bir işaretidir. yeteneklerin. Ancak, orijinal kodu yerinde bırakmanın iyi bir biçim olduğunu yorumluyorum, yeniden yazarken gerekli işlevselliği yanlışlıkla kaldırmadığınızdan emin oluncaya kadar yorumladı. Kimse mükemmel değildir.

Genellikle kod bir nedenden dolayı kesin bir şekilde yazılır. Değişikliği yazara bildirmek her zaman en iyisini yapmaya çalışır.