Bagaimana anda mendekati usaha memahami codebase yang besar dan tanpa dokumentasi yang baru anda warisi?

Question

Accepted Answer

Apabila anda mewarisi codebase tanpa dokumentasi, tahan keinginan untuk membaca setiap fail dari atas ke bawah atau untuk merefaktor apa yang kelihatan hodoh. Anda belum memahaminya lagi, dan refaktor awal pada kod yang disalah faham adalah cara anda mencipta gangguan perkhidmatan. Matlamatnya ialah membina model mental yang tepat, dengan pantas, daripada tingkah laku sebenar dan bukan tekaan.

## Pendekatan praktikal

- **Jalankannya secara setempat dahulu.** Membuatnya build dan berjalan mengajar anda tentang stack, kebergantungan, dan titik kesakitan persediaan sebelum anda membaca satu baris logik.
- **Jejaki satu aliran pengguna sebenar dari hujung ke hujung.** Pilih sesuatu yang konkrit (login, checkout, sebuah laporan) dan ikutinya dari entry point ke pangkalan data dan kembali. Satu aliran yang difahami secara mendalam mengatasi sepuluh yang diimbas sepintas lalu.
- **Baca model data.** Schema dan objek domain teras mendedahkan apa yang sebenarnya dilakukan oleh sistem dan bagaimana konsep saling berkaitan, selalunya lebih jujur daripada kod itu sendiri.
- **Cari entry points.** Routes, controllers, message consumers, cron jobs, fungsi main. Inilah pintu masuk ke dalam sistem.
- **Gunakan tests dan logging untuk mengesahkan tingkah laku.** Tambah satu baris log atau breakpoint dan perhatikan realiti dan bukan membuat andaian. Tests sedia ada mendokumenkan tingkah laku yang diniatkan.
- **Berbincang dengan orang yang mengenalinya.** Tiga puluh minit bersama seseorang yang melalui keputusan tersebut menjimatkan berhari-hari arkeologi. Tanya *mengapa*, bukan sekadar *apa*.
- **Tuliskan peta sambil anda meneroka.** Dokumen berjalan tentang modul, aliran, dan perangkap mengubah usaha anda menjadi sesuatu yang boleh digunakan semula oleh orang seterusnya dan diri anda di masa hadapan.

## Apa yang perlu dielakkan

Jangan merefaktor sebelum anda faham. Jangan percayakan komen melebihi tingkah laku. Jangan cuba memegang keseluruhan sistem dalam fikiran anda sekaligus; kedalaman pada bahagian yang penting mengatasi keluasan cetek di mana-mana.

## Mengapa ia penting

Kebanyakan kerja kejuruteraan berlaku dalam kod yang ditulis oleh orang lain. Seorang tech lead yang boleh membina model mental sistem asing dengan pantas dan selamat akan membuka jalan kepada seluruh pasukan, menskop kerja dengan tepat, dan mengelakkan kesilapan mahal menukar perkara yang mereka belum fahami.