Daha iyi bir geliştirici olmak için kod incelemeleri
Deneyimlerime göre, bir geliştirici olarak seviye atlamanın en etkili yolu bir kod incelemesine katılmaktır. İncelenen değişiklikleri oluşturan sizseniz, iş arkadaşlarınızdan doğrudan geri bildirim alabilirsiniz. Ve gözden geçirenlerden biriyseniz, uygulamaları nasıl çözeceğiniz konusunda düşünmemiş olabileceğiniz farklı yaklaşımları öğrenebilirsiniz.
Ancak bir kod incelemesini doğru bir şekilde vermek ve anlamak, öğrenilmesi gereken bir beceridir. Bu yazıda, kod incelemeleri verirken ve alırken dikkate aldığım bazı hususları basitçe listeleyeceğim. Benim bakış açıma göre, işbirlikçi ve sıcak bir geliştirme ortamı için doğru seçim olduklarını kanıtladılar.
İyi kod olarak tanımladığım şey
Geçici bir çözümden daha kalıcı bir şey olmadığını unutmayın.
Aşağıdaki temel metrikler, kod yazarken ve gözden geçirirken bana yol gösteriyor.
- kodun bakımı yapılabilir, ör. ne kadar iyi belgelenmiş olursa olsun hack veya geçici çözüm yok
- kod kolayca okunabilir, bu nedenle bunun hakkında akıl yürütmek çok daha kolay
- kod test edilebilir, böylece önceki iki noktayı daha da iyileştirir
Kod incelemesi nasıl yapılır
Mütevazı olmak
Yanlış olmak sorun değil. Objektif olarak haklı olmadığınız halde haklı olduğunuzda ısrar etmek bir problemdir. Her zaman bir şeyi kaçırabileceğinizi veya kodu yanlış anlayabileceğinizi unutmayın. Tepkilere açık olun ve yeni bir şeyler öğrenme şansı için mütevazi olun.
Kod incelemeleri kişisel değildir
Unutmayın: kod önce gelir. İkinizin de birbirinizle konuşma havasında olmadığınız veya genel olarak işlerin şu andaki işleyiş şekli hakkında fikir ayrılığına düştüğünüz gergin bir durumda birinin kodunu gözden geçirebilirsiniz.
Kod incelemeleri, biraz stres atmanın veya hayal kırıklıklarını geri ödemenin yeri değildir. İncelemelerin tek amacı, kod kalitesini nesnel olarak iyileştirmektir. İncelediğiniz ve birleştirilecek olan kod bir sonraki eski koddur, bu nedenle kişisel şeyleri bir kenara bırakmak ve incelenen kim olursa olsun tarafsız bir inceleme sağlamak önemlidir.
Görüşler inceleme değildir
İyi bir inceleme ile yalnızca bir yorum arasındaki temel fark, incelemelerin fikirleri dışarıda bırakmasıdır. Örneğin, bakımı yapılabilir, kolay okunabilir ve test edilebilir olduğu sürece kod stilinin nasıl göründüğü önemli değildir. Yorumunuzun fikir sahibi olup olmayacağından emin değilseniz, konuyu iş arkadaşınızla tartışabilmeniz için bir açıklama eklemeniz yeterlidir.
İyi yorumlar iyi tartışmalara yol açar
Bir incelemeye meydan okumak, geliştiriciler arasında büyük bilgi aktarımlarına yol açabilir. Belirli bir inceleme, nihai bir yorum olarak değil, tüm resmi elde etmek için tartışmalar için bir başlangıç noktası olarak ele alınmalıdır. İkiniz de bir şeyleri kaçırabilirsiniz ve eleştiriyi tartışmak yalnızca içgörülerinizi geliştirebilir.
Son tarihler önemli değil
Uygulanması her zaman kolay değildir, ancak kod incelemelerini atlamak, potansiyel olarak kimsenin temizlemek istemeyeceği büyük bir teknik borç yaratabilir. Saatin tik taklarını duysanız bile kapsamlı kod incelemeleri yapmak için gerekli disiplini korumak önemlidir. Bu karmaşa üzerinde çalışacak bir sonraki geliştirici siz olabilirsiniz!
Referanslar için bağlantıları kullanın
İncelenen kodu mevcut kodla karşılaştırmak oldukça sık gerçekleşir. Bu nedenle, bağlantılar aracılığıyla referansları doğru bir şekilde eklemek önemlidir. Sadece referans verilen kodun bulunduğu yaklaşık yerden bahsetmek onu kesmez.
Mevcut bir daldaki kodu vurgulamak için kaynak kontrolünüzün özelliğini kullanın ve referans için incelemenizde oluşturulan URL'leri kullanın. Aynısı, örneğin MDN'deki harici belgeler için de geçerlidir.
Bir kod incelemesi nasıl okunur
Yukarıdakilerin hepsi
Kodunuzun kod incelemelerini okumak, yukarıda belirtilen tüm noktaları takip ettiğinizde sizi daha iyi bir geliştirici yapar. Alçakgönüllü olun, eleştiriyi kişisel algılamayın ve büyük resmi daha iyi anlamak için bir incelemenin neye işaret ettiğini anlamaya çalışın.
Nasıl objektif olunacağına dair kişisel bir görüş
Bu makale, kod incelemeleri konusundaki kişisel yaklaşımımı yansıtmaktadır. Ana hatlarıyla belirtilen noktalar, hem yerel hem de uluslararası olmak üzere büyük ve küçük ekiplerde bir geliştirici olarak deneyimimin yalnızca bir doruk noktasıdır. İşe yaradıklarını kanıtladılar, daha iyi koda yol açtılar ve bana başkalarından doğrudan öğrenme fırsatı verdi.
