Bilmediğiniz bir kod tabanını tanımlamak için hangi araçlar veya teknikler yararlıdır? [kapalı]

Bilmediğiniz kodu manuel olarak incelerken (gözden geçirmek veya değiştirmek için), üç seçeneğim var gibi görünüyor.

• Bir yukarıdan aşağıya okumak dosya görünüyor nasıl temel her bir sonraki kaynak dosyasını seçerek kod. Genellikle neredeyse her şeyi okurum. Bazı dosyalar iki kez.
• Bir genişliği birinci okuma ı bulmak ve minimal bir anlayışla çağıran yönteminin okuma. Sonra fonksiyon olarak adlandırılan tüm fonksiyonları okuyun, vb. Zihinsel yığınım birkaç çağrı yaparsam taşma eğilimindedir.
• Bir derinlik ilk okuma bu olsun emin bir hata ayıklayıcıda tüm kod adım, 8 dakika veya 8 saat sürecektir.

Ne yaptığı hakkında oldukça sağlam bir anlayışa sahip olmak için yeterince kod okuduktan sonra , temel kod% 20 veya daha az iken, genellikle kod tabanının% 80 veya daha fazlasını okuduğumu yansıtırım . Çok zaman harcadım.

Unfamilar kodu hızlı bir şekilde kavramak için hangi araçlar yararlıdır? Kritik kod yolunun "büyük resmini" verebilecek ve herhangi bir parçanın ayrıntılarını ayrıntılı olarak inceleyebileceğim herhangi bir araç var mı?

En iyi şey, elbette, kod tabanını bilen birinin size yol göstermesi içindir. Bu bir seçenek değilse, size yardımcı olabilecek bazı araçlar vardır.

• VisualStudio otomatik olarak bir kod tabanının UML sınıfı diyagramı oluşturabilir. En azından size sınıf hiyerarşilerini gösterecek.
• Oksijen son derece yardımcı olabilir. Kodda doxygen tarzı yorumlar olmasa bile, doxygen hala okunamayan belgeler, sınıf diyagramları ve çağrı grafikleri oluşturabilir, bu da tanımadığınız bir kod tabanı çevresinde yolunuzu bulmak için çok yararlı olabilir.

Genellikle, herhangi bir şeyi sağ tıklayıp "tanımlamaya" gidebileceğiniz tam özellikli bir IDE kullanmak da istersiniz. Bu, karmaşık bir dizin yapısında birçok dosyada grep kullanımı ile karşılaştırıldığında size çok zaman kazandırabilir.

Kodla ne kadar süre uğraşmanız gerektiğine bağlı olarak başka bir önemli şey. Birim testleri varsa, testlere bakın. Test yoksa, yazmaya başlayın. Belirli bir sınıfın veya işlevin ne yaptığına dair bir hipotez oluşturun ve test etmek için bir test yazın. Bu çok disiplin gerektirir, ancak kodda neler olduğu hakkında cevaplar almak için harika bir yoldur.

Bu daha sert bir yaklaşım. Bu teknik, anlamlı ad alanlarına yerleştirilmemiş birçok sınıfı olan bir proje için yararlı olabilir.

Bu alıştırmanın amacı sınıf ilişkisini keşfetmektir. Projenin atılabilir bir klonunu yapın ve ardından bazı sınıfları ad alanlarına yerleştirmeye çalışın. Tekrarlanan denemelerde zaman kazanmak için, bu değişikliği otomatikleştirmek üzere bazı Regex dosya işleme araçlarını kullanın.

Bu, birçok derleyici hatasına neden olacaktır. Bu hataları düzeltme sürecinde, bu sınıfların birbirine nasıl bağlı olduğu daha iyi kavranacak ve hangi sınıfların aynı ad alanına yerleştirilebileceğine karar verilecektir.

Bu teknik, projenin kod organizasyonunu çok az anlamadan bile uygulayabilmesi açısından faydalıdır. Bununla birlikte, bazı sınıfların yanlış anlama nedeniyle bu teknikle yanlış yerleştirilme riski ortaya çıkar.