Catatan Tutorials

Membaca kode orang lain

Sebagian besar kode yang Anda kerjakan ditulis orang lain, sering kali oleh orang yang sudah tidak bisa ditanya. Cara memahami arah proyek, mengikuti satu jalur alih-alih membaca semuanya, menemukan sesuatu dengan cepat, bertanya pada git kenapa sebuah baris ada, dan mengunci perilaku sebelum mengubahnya.

6 menit bacaTersedia juga dalam bahasa Inggris →

Belajar pemrograman biasanya berarti menulis kode dari file kosong. Bekerja sebagai programmer kebanyakan berarti hal lain: membuka proyek yang sudah berisi ribuan baris, ditulis orang yang mungkin tidak pernah Anda temui, lalu mengubah satu hal kecil tanpa merusak sisanya. Bagian 11 mengutip PEP 8: “code is read much more often than it is written.” Bagian ini membahas sisi membacanya.

Bahkan ada bidang riset khusus untuk ini. Program comprehension adalah “a domain of computer science concerned with the ways software engineers maintain existing source code”: cabang ilmu komputer tentang cara programmer merawat kode yang sudah ada. Tapi Anda tidak perlu risetnya. Yang Anda perlukan adalah beberapa kebiasaan.

Jangan mulai dari baris 1

Kesalahan paling umum adalah membuka file pertama lalu membacanya dari atas ke bawah seperti buku. Kode tidak ditulis untuk dibaca dengan cara itu. Anda akan tenggelam dalam detail sebelum tahu mana yang penting.

Bacalah dari luar ke dalam:

  1. Untuk apa proyek ini? Baca README, deskripsi proyek, nama-nama folder. Satu kalimat cukup: “backend toko yang menghitung total pesanan dan mengimpor pesanan dari CSV.”
  2. Bagaimana menjalankannya? Cari titik masuknya: main.py, index.php, main.go, script di package.json, Makefile. Jalankan kalau bisa. Program yang berjalan menjawab pertanyaan yang tidak bisa dijawab dengan membaca.
  3. Bagaimana susunannya? Lihat pohon folder, bukan isi file. Bagian mana yang urusan web, mana yang urusan data, mana yang aturan bisnis?
  4. Ada tes? Tes adalah contoh cara kode dimaksudkan untuk dipakai, ditulis oleh orang yang memahaminya.

Ikuti satu jalur

Setelah tahu arah, jangan mencoba memahami semuanya. Pilih satu hal yang terjadi lalu ikuti sampai ujung: satu request halaman, satu tombol, satu laporan, satu perintah. Mungkin Anda hanya menyentuh lima sampai sepuluh file dari ratusan, tapi Anda memahaminya dengan baik.

Ini dekomposisi dari bagian 9, tapi terbalik. Di sana Anda memecah masalah menjadi fungsi. Di sini Anda mulai dari fungsi lalu mencari tahu masalah apa yang diselesaikannya.

Catat yang Anda temukan sambil jalan. Daftar pendek sudah cukup:

POST /orders
  → routes/orders.py: create_order()
  → shop/orders.py: order_total(items)
  → shop/pricing.py: final_price(price, qty)   ← discount logic lives here

Peta kecil itu lebih berharga daripada satu jam membaca, dan itulah yang Anda butuhkan minggu depan saat sudah lupa.

Temukan sesuatu dengan cepat

Sisa bagian ini memakai proyek contoh kecil: toko dengan orders.py dan pricing.py, serta riwayat tiga commit.

Cari di seluruh proyek. git grep akan “Look for specified patterns in the tracked files in the work tree”, mencari pola di file yang dilacak git. Karena hanya mencari di file yang dikenal git, node_modules dan hasil build ikut terlewati:

$ git grep -n "final_price"
shop/orders.py:1:from shop.pricing import final_price
shop/orders.py:4:    return sum(final_price(i["price"], i["qty"]) for i in items)
shop/pricing.py:1:def final_price(price, qty):

Satu perintah menunjukkan di mana fungsi didefinisikan dan semua tempat yang memakainya.

Lompat ke definisi. Setiap editor yang serius punya “Go to definition” dan “Find all references”. Hafalkan shortcut-nya. Ini alat membaca paling berguna yang Anda punya.

Tanya program yang sedang berjalan. Saat nama dipakai ulang atau kode dimuat secara dinamis, bahasanya sendiri bisa memberi tahu asal sesuatu. Modul inspect di Python membantu “get information about live objects”, dan inspect.getsourcefile mengembalikan “the name of the Python source file in which an object was defined”, nama file tempat objek itu didefinisikan:

import inspect
from shop.orders import final_price
print(inspect.getsourcefile(final_price))
print(inspect.getsource(final_price))
…/shop/pricing.py
def final_price(price, qty):
    total = price * qty
    if qty >= 10:
        total = total * 95 // 100
    if total < 0:
        total = 0
    return total

final_price diimpor lewat shop.orders, tapi tempat aslinya shop/pricing.py. Reflection di PHP melakukan hal yang sama; getFileName “Gets the file name from a user-defined function”:

$f = new ReflectionFunction('finalPrice');
echo $f->getFileName(), ':', $f->getStartLine(), '-', $f->getEndLine();
// → …/src/pricing.php:2-8

Tanyakan alasannya pada riwayat

Kode memberi tahu apa yang terjadi. Jarang sekali ia memberi tahu kenapa. Riwayatnya sering bisa.

git blame akan “Show what revision and author last modified each line of a file”, menunjukkan commit dan penulis terakhir yang mengubah setiap baris. Misalnya Anda bingung dengan dua baris ini di final_price. Bagaimana total bisa negatif?

$ git blame -L 5,6 --date=short shop/pricing.py
19474ea4 (Ana 2026-08-21 5)     if total < 0:
19474ea4 (Ana 2026-08-21 6)         total = 0

Dan pesan commit untuk 19474ea:

Fix negative totals from refund rows (qty = -1) in CSV import

Sekarang masuk akal: impor CSV berisi baris refund dengan jumlah negatif, dan baris itu dulu menghasilkan total negatif. Tanpa riwayat, Anda mungkin “merapikan” pengecekan aneh itu dan memunculkan bug-nya lagi.

git log -S mencari commit yang menambah atau menghapus sepotong teks. Berguna saat Anda ingin tahu kapan sebuah aturan diperkenalkan:

$ git log -S "95 // 100" --oneline
5492637 Add 5% bulk discount for 10+ items

Ini juga alasan kuat untuk menulis pesan commit yang menjelaskan kenapa. Orang berikutnya yang membaca git blame bisa jadi Anda sendiri.

Kode aneh biasanya punya alasan

Ada prinsip untuk ini yang disebut pagar Chesterton (Chesterton’s fence): “reforms should not be made until the reasoning behind the existing state of affairs is understood”, jangan mengubah sesuatu sebelum paham kenapa ia ada. Kalau Anda menemukan pagar di tengah lapangan dan tidak tahu gunanya, cari tahu dulu sebelum merobohkannya.

Di kode, pagarnya adalah if yang aneh, sleep(1) tambahan, kasus khusus untuk satu ID pelanggan. Kadang memang sisa yang terlupa. Sering kali itu perbaikan untuk masalah yang belum Anda alami. Cek riwayatnya, cari tiket terkait, tanya orang. Baru putuskan.

Jalankan dan amati

Membaca itu menebak. Menjalankan itu memeriksa. Saat tidak yakin apa yang dilakukan sepotong kode, suruh kode itu yang memberi tahu:

  • Panggil langsung dengan beberapa input di REPL atau skrip kecil.
  • Cetak nilainya di titik yang membuat Anda ragu.
  • Pakai debugger. Di Python, breakpoint() “drops you into the debugger at the call site”, membawa Anda ke debugger tepat di titik pemanggilannya; lalu Anda bisa melihat setiap variabel dan menjalankan baris demi baris. PHP punya Xdebug, Go punya Delve, dan browser punya DevTools untuk JavaScript.

Memanggil final_price dengan beberapa input hanya butuh beberapa detik dan menjawab beberapa pertanyaan sekaligus:

(100, 1) 100
(100, 10) 950
(333, 10) 3163
(100, -1) 0

Perhatikan (333, 10): 3.330 dikurangi 5% adalah 3.163,5, dan kodenya mengembalikan 3.163. Operator // membulatkan ke bawah. Apakah itu disengaja? Pertanyaan ini tidak akan muncul kalau Anda hanya membaca kodenya.

Kunci perilakunya sebelum mengubah

Sebelum mengubah kode yang belum sepenuhnya Anda pahami, tulis tes yang mencatat apa yang dilakukannya sekarang. Ini disebut characterization test: “a means to describe (characterize) the actual behavior of an existing piece of software”, yang “protect existing behavior of legacy code against unintended changes”. Tes ini menggambarkan perilaku nyata kode yang sudah ada dan melindunginya dari perubahan yang tidak disengaja.

from shop.pricing import final_price

# Characterization tests: they record what the code does today,
# not what we think it should do.
def test_single_item():
    assert final_price(100, 1) == 100

def test_bulk_discount_starts_at_10():
    assert final_price(100, 9) == 900
    assert final_price(100, 10) == 950

def test_discount_rounds_down():
    assert final_price(333, 10) == 3163

def test_refund_rows_become_zero():
    assert final_price(100, -1) == 0
....                                                                     [100%]
4 passed in 0.01s

Perhatikan bahwa tes pembulatan mencatat perilaku saat ini meskipun Anda belum yakin itu benar. Memang itu tujuannya: kalau perubahan Anda menggeser pembulatan, tes gagal dan Anda yang memutuskan apakah itu disengaja, bukan baru tahu dari keluhan pelanggan. Bagian 14 membahas testing lebih lengkap.

Kebiasaan yang membantu

  • Membaca dengan pertanyaan. “Di mana diskon dihitung?” bisa dijawab. “Bagaimana proyek ini bekerja?” tidak bisa, setidaknya di awal.
  • Simpan catatan dan peta. Nama file, nama fungsi, masing-masing satu baris.
  • Ganti nama dan beri komentar secara lokal saat menjelajah, di branch sementara, kalau itu membantu Anda paham. Buang setelahnya, atau jadikan perapian sungguhan.
  • Jangan buru-buru menilai. Kode yang tampak jelek sering ditulis di bawah batasan yang tidak terlihat: tenggat, library lama, bug di browser yang sudah lama hilang.
  • Bertanya. Kalau penulisnya masih ada, lima menit waktunya bisa menghemat satu sore Anda. Datang dengan pertanyaan spesifik dan apa yang sudah Anda temukan.

Kenapa ini penting sehari-hari

  • Kebanyakan pekerjaan adalah mengubah kode yang sudah ada. Perbaikan bug, fitur baru, dan upgrade semuanya dimulai dari membaca.
  • Onboarding. Pekerjaan atau proyek baru kebanyakan berisi berminggu-minggu membaca. Melakukannya dengan sistematis mempersingkat waktu itu.
  • Lebih sedikit regresi. Memahami kenapa sebuah baris ada, dan mengunci perilaku dengan tes, adalah cara menghindari bug lama muncul lagi.
  • Kode hasil AI adalah kode orang lain. Semua yang di sini berlaku: jalankan, ikuti satu jalur, periksa bagian yang aneh, dan kunci perilakunya sebelum Anda memercayainya. Bagian 24 kembali ke topik ini.

Coba sendiri

  1. Pilih proyek open-source yang Anda pakai. Tanpa membaca kodenya, tulis satu kalimat tentang fungsinya dan temukan titik masuknya.
  2. Pilih satu fitur dan ikuti dari titik masuk sampai fungsi yang mengerjakannya. Tulis petanya seperti contoh di atas.
  3. Jalankan git blame pada baris yang membingungkan di proyek yang punya riwayat. Apakah pesan commit-nya menjelaskan?
  4. Tulis tiga characterization test untuk fungsi yang bukan Anda tulis, termasuk satu untuk perilaku yang mengejutkan Anda.

Ringkasan

  • Baca dari luar ke dalam: tujuan, titik masuk, susunan, tes. Jalankan kalau bisa.
  • Ikuti satu jalur di kode alih-alih membaca semuanya; catat petanya.
  • Temukan sesuatu dengan pencarian (git grep), go to definition, dan introspeksi bahasanya (inspect, Reflection).
  • Tanyakan alasannya pada riwayat: git blame, git log -S, dan pesan commit yang baik.
  • Hormati pagar Chesterton: pahami kode aneh sebelum menghapusnya.
  • Jalankan dan amati, lalu kunci perilaku saat ini dengan characterization test sebelum mengubahnya.

Referensi