Blogger Jateng
Home / Tutorial

Membaca dan Memahami Basis Kode

Ketika berhubungan dengan tim pengembangan perangkat lunak baru atau proyek yang tidak dikenal, salah satu titik kesulitan yang paling umum adalah memahami basis kode yang ada. Basis kode bisa sangat kompleks, mencakup banyak file, banyak kerangka kerja, dan banyak teknologi. Namun, kemampuan untuk menavigasi dan memahami semua hal tersebut secara efisien adalah keterampilan yang harus kita kembangkan, untuk produktivitas dan kontribusi yang berarti. Dalam artikel ini, kita akan membahas beberapa tips untuk membaca basis kode untuk pengembang.

1. Mulailah dengan Dokumentasi

Jadi, dapatkan lebih banyak pengetahuan dalam dokumentasi sebelum mengerjakan kode. Seperti file README, diagram arsitektur, skema, dan dokumentasi API. Sumber daya tersebut biasanya berisi informasi yang berguna tentang tujuan keseluruhan, struktur, dan aspek-aspek penting dari proyek. Jika tidak ada dokumentasi, catatlah hal ini, karena hal ini dapat mengisyaratkan perbaikan dalam proyek.

sumber: studentorg.berkeley.edu

2. Menyiapkan Lingkungan Pengembangan

Untuk terlibat langsung dengan basis kode, ada baiknya Anda menyiapkan lingkungan pengembangan. Gunakan panduan penyiapan yang disediakan untuk memastikan proyek berjalan secara lokal. Pada tahap ini, Anda mungkin perlu menginstal dependensi, mengatur variabel lingkungan, atau belajar tentang proses build. Namun, hal ini akan memberikan Anda kepercayaan diri dengan membuatnya praktis untuk bermain-main dengan kode, jika Anda dapat menjalankan proyek dengan kode yang ada saat ini.

3. Identifikasi Komponen Utama

Setiap basis kode memiliki komponen penting yang membentuk tulang punggungnya. Komponen-komponen tersebut dapat meliputi:
  • Titik Masuk: Cari file seperti index.js, main.py, dll) yang kemudian akan menjadi titik masuk untuk dijalankan.
  • Logika Perutean: File routing menentukan bagaimana permintaan diproses dalam aplikasi web dan titik akhir yang dituju.
  • Modul Inti: Menunjukkan direktori atau berkas yang berkaitan dengan logika bisnis, utilitas, dan layanan.
  • File Konfigurasi: File seperti. env, settings. json, atau config. yaml sering kali berisi konfigurasi penting yang mengontrol perilaku aplikasi.
Memahami komponen-komponen ini membantu Anda memahami keseluruhan struktur dan fungsionalitas proyek.

4. Melacak Alur Eksekusi

Untuk memahami cara kerja aplikasi, ikuti alur eksekusinya. Mulailah dari titik masuk dan telusuri bagaimana program memproses permintaan atau melakukan tindakan. Gunakan alat debug atau tambahkan pernyataan logging untuk mengamati aliran data dan mengidentifikasi metode dan fungsi utama.

5. Membiasakan Diri Anda dengan Tumpukan Teknologi

Ada sekumpulan bahasa, kerangka kerja, dan pustaka tertentu yang menggerakkan setiap basis kode. Jika ada teknologi yang tidak Anda kenal, luangkan waktu untuk mempelajari dasar-dasarnya. Mengetahui bagaimana prinsip-prinsip umum dari sebuah framework seperti React atau Django bekerja dapat membantu Anda memahami kode yang terkait. Selain itu, periksa juga ketergantungan eksternal yang disebutkan dalam berkas seperti package.json atau requirements.txt.

6. Memahami Standar dan Praktik Pengkodean

Lihat konvensi pengkodean proyek. Contoh standar pengkodean adalah konvensi penamaan, konvensi pemformatan kode, atau pola seperti (MVC Model-View-Controller). Panduan ini memfasilitasi konsistensi dan memastikan bahwa upaya Anda menyatu dengan baik ke dalam labirin kode saat ini.

7. Meninjau Riwayat Git

Memahami Evolusi Basis Kode menggunakan sistem kontrol GitVersion seperti GIT. Pesan komit dan pull request juga dapat memberi tahu kita wawasan tentang mengapa perubahan tertentu dibuat dan apa yang tampaknya mendapatkan lebih banyak perhatian dari pengembang. Ini juga merupakan cara yang sangat baik untuk mempelajari alur kerja tim dan budaya pengkodean.

8. Ajukan Pertanyaan

Jika Anda menemukan bagian kode yang membingungkan atau asing, jangan ragu untuk bertanya. Berbicara langsung dengan anggota tim dapat membantu Anda mengklarifikasi asumsi, mengungkap ketergantungan yang tersembunyi, dan mempercepat pemahaman Anda tentang pekerjaan yang sedang dilakukan. Pastikan untuk mengajukan pertanyaan spesifik yang menunjukkan bahwa Anda telah berusaha dan memperhatikan waktu orang lain. 

9. Menulis Catatan dan Diagram

Buatlah catatan Anda sendiri dan buatlah diagram Anda sendiri saat Anda mempelajari basis kode. (Ini adalah catatan saya sendiri yang berfungsi sebagai referensi bagi saya, tetapi juga dapat berfungsi sebagai dokumentasi untuk proyek ini). Jenis hubungan organisasi yang intuitif dan terukur dapat diukur dan dipetakan.

10. Berkontribusi Secara Bertahap

Setelah Anda memiliki pemahaman awal, mulailah dengan kontribusi kecil seperti perbaikan bug atau peningkatan dokumentasi. Ini adalah binari yang cukup kecil sehingga Anda dapat berinteraksi dengan basis kode dalam ukuran bit yang dapat diatur, yang dapat membuat Anda terbiasa dan percaya diri dengan basis kode saat Anda maju. Secara bertahap, Anda akan mengembangkan kemahiran untuk mengatasi tantangan yang lebih signifikan.

Kesimpulan

Membaca dan memahami basis kode adalah keterampilan yang sangat penting bagi para pengembang. Dengan mengikuti pendekatan yang sistematis-dimulai dengan dokumentasi, menyiapkan lingkungan, mengidentifikasi komponen inti, dan mencari bantuan saat dibutuhkan-Anda dapat dengan cepat menyesuaikan diri dengan proyek yang paling kompleks sekalipun. Ingatlah bahwa kesabaran dan ketekunan adalah kuncinya; setiap langkah yang Anda ambil akan memperdalam pemahaman Anda dan meningkatkan kemampuan Anda untuk berkontribusi secara bermakna kepada tim.