Devralınan büyük, belgesiz bir kodtabanını anlamaya nasıl yaklaşırsınız?

Question

Accepted Answer

Belgesiz bir kodtabanını devraldığınızda, her dosyayı baştan sona okuma veya çirkin görünen şeyleri yeniden düzenleme dürtüsüne direniş gösterin. Henüz anlamadığınız için, yanlış anlaşılmış kod üzerinde yapılan erken yeniden düzenlemeler kesintilere neden olur. Amaç, tahminlerden ziyade gerçek davranıştan hızlı bir şekilde doğru bir zihinsel model oluşturmaktır.

## Pratik bir yaklaşım

- **Önce yerel olarak çalıştırın.** Onu derleme ve çalışma durumuna getirmek, bir satır mantık okumadan önce yığını, bağımlılıkları ve kurulum zorlukları öğretir.
- **Bir gerçek kullanıcı akışını baştan sona izleyin.** Somut bir şey seçin (giriş, ödeme, bir rapor) ve bunu giriş noktasından veritabanına ve geri gelen yolculuğu izleyin. Birini derinlemesine anlamak on taneyi hızlıca geçmekten daha iyidir.
- **Veri modelini okuyun.** Şema ve temel etki alanı nesneleri, sistemi gerçekte ne yaptığını ve kavramların nasıl ilişkili olduğunu, genellikle koddan daha dürüst bir şekilde ortaya koymaktadır.
- **Giriş noktalarını bulun.** Rotalar, kontrolörler, mesaj tüketicileri, cron işleri, ana işlev. Bunlar sisteme giden kapılarıdır.
- **Davranışı doğrulamak için testleri ve günlüklemeyi kullanın.** Bir günlük satırı veya kesme noktası ekleyin ve tahmin etmek yerine gerçekliği izleyin. Mevcut testler amaçlanan davranışı belgelemektedir.
- **Onu bilen kişilerle konuşun.** Yaşadığı kararlar hakkında kırk beş dakika birisiyle konuşmak günlerce kazı tasarrufu sağlar. *Ne* değil, *neden* sorun.
- **Giderken bir harita yazın.** Modüllerin, akışların ve tuzakların devam eden bir dokumentasyonu, çabalarınızı sonraki kişinin ve gelecekteki kendinizin tekrar kullanabileceği bir şeye dönüştürür.

## Kaçınılması gerekenler

Anlamadan önce yeniden düzenlemeyin. Açıklamalar yerine davranışa güvenmeyin. Bütün sistemi bir kerede aklınızda tutmaya çalışmayın; önemli olan parçalar üzerinde derinlik her yerde sığ derinlikten daha iyidir.

## Neden önemli

Mühendislik işinin çoğu başka birinin yazdığı kodda gerçekleşir. Bilinmeyen sistemlerin zihinsel modelini hızlı ve güvenli bir şekilde oluşturabilen bir teknik lider, tüm ekibi engelden kurtarır, işleri doğru kapsamlandırır ve henüz anlamadıkları şeyleri değiştirmenin pahalı hatasını önler.