Tanyakan HN: Bagaimana Anda mempertahankan anotasi pribadi untuk kode yang tidak Anda kendalikan?

Saya menghabiskan banyak waktu untuk membaca dan memahami basis kode yang tidak saya kendalikan (perpustakaan sumber terbuka, sistem warisan internal, dll.). Saat saya membangun pemahaman, saya perlu mendokumentasikan wawasan, pemahaman, dan model mental saya – tetapi catatan ini murni bersifat pribadi dan tidak boleh menjadi bagian dari basis kode sebenarnya.

Tantangan saya:

1. Anotasi ini harus digabungkan dengan lokasi tertentu dalam kode sumber (fungsi tertentu, variabel, atau bahkan baris tertentu)

2. Kode yang mendasarinya berubah secara berkala (versi baru, pembaruan dari pengelola) yang dapat memutus hubungan antara catatan saya dan kode

3. Catatan saya bersifat pribadi – berisi pemikiran setengah jadi, pertanyaan, dan terkadang observasi kritis yang tidak pantas dijadikan komentar publik

4. Saya ingin melestarikan pengetahuan ini di berbagai mesin dan lingkungan kerja

Saya telah mencoba berbagai pendekatan: – Bookmark IDE lokal (hilang di antara sesi) – Pisahkan file penurunan harga (sulit untuk mempertahankan referensi kode yang tepat) – Garpu pribadi dengan komentar (menjadi tidak dapat dikelola seiring berkembangnya sumber)

Saya ingin tahu bagaimana orang lain mengatasi masalah ini. Apakah Anda memiliki pendekatan sistematis untuk mempertahankan anotasi pribadi pada kode yang tidak berada di bawah kendali Anda? Bagaimana Anda menangani tantangan perkembangan kode sekaligus menjaga catatan Anda tetap relevan?

Saya sangat ingin mendengar masukan dari orang-orang yang bekerja dengan basis kode besar atau mereka yang sering kali perlu mendalami ketergantungan eksternal.