Meskipun beberapa jawaban yang bermanfaat telah diposting di sini untuk sementara waktu, saya yakin ada ruang untuk satu lagi. Saran saya adalah, seperti yang orang lain katakan, untuk melakukan tinjauan kode. Tetapi perlu disebutkan lagi karena istilah "review kode" sangat kabur ... hampir sama kaburnya dengan "kode bersih" :-). Saya telah menghabiskan banyak waktu dan usaha sendiri dalam bekerja menuju tujuan yang sulit dipahami itu. Dan khususnya dalam beberapa tahun terakhir, didorong oleh rekan-rekan yang berbagi hasrat saya, saya menyaring gagasan saya, dicampur dengan ide-ide kunci dari pengembang terkemuka, ke dalam seri yang berjudul Zen of Code Reviews .
Artikel saya unik, sejauh yang saya tahu, karena saya membahas kedua sisi lorong: melakukan peninjauan kode sebagai penulis dan melakukan peninjauan kode sebagai peninjau . Meskipun terkait, keterampilan untuk masing-masing agak berbeda. Dan mampu melakukan keduanya dengan baik akan menghasilkan kualitas kode yang lebih baik. Meninjau kode sama pentingnya dengan menulis kode. Betulkah. Ini mempromosikan transfer pengetahuan, mendorong konsistensi tim dan komunikasi, membantu Anda meningkatkan keahlian Anda, dan yang tak kalah penting, ini mengurangi biaya perangkat lunak kereta - dari sedekat mungkin dengan awal.
Dua yang pertama memberikan tips dan teknik untuk mempersiapkan tinjauan kode. Pendeknya:
- Anda sebagai penulis memiliki pengetahuan mendalam tentang mengapa setiap baris yang diubah ada dalam tinjauan kode Anda. Banyak yang jelas bagi resensi yang berpendidikan, tetapi banyak yang tidak. Sampaikan poin-poin itu dengan memberi anotasi pada tinjauan kode Anda sebelum Anda mengirimkannya kepada pengulas.
- Bahkan sebelum itu, pertimbangkan dengan cermat apa yang termasuk dalam tinjauan kode Anda: pastikan Anda menyertakan semua perubahan yang relevan untuk suatu masalah dan cobalah untuk tidak memasukkan lebih dari satu masalah.
- Pastikan Anda melakukan checkout kontrol sumber (untuk menyelaraskan kembali kode Anda dengan utama) sebelum Anda mengirimkannya.
- Tinjau kode Anda sendiri sebelum Anda mengirimkannya - baris demi baris!
Bagian 1: Komentar Pra-Tinjauan: Memberdayakan kolega Anda untuk memberi Anda umpan balik yang lebih baik pada ulasan kode Anda
Bagian 2: Praktik Terbaik: Pedoman untuk mempersiapkan tinjauan kode
Dan dua artikel lainnya memberikan saran praktis tentang cara menjadi peninjau yang lebih baik:
- Baca Jira / masalah / tiket / persyaratan (apa pun namanya) terlebih dahulu.
- Pastikan tes unit mencakup persyaratan.
- Tinjau tes unit untuk kelas kesetaraan dan kelengkapan nilai batas.
- Pastikan setiap pengujian unit cukup, tidak menguji banyak hal.
- Tinjau kode untuk kepatuhan pada prinsip-prinsip SOLID.
- Berhati-hatilah terhadap penemuan kembali roda, kode yang terlalu rumit, dan hanya kode yang rumit.
- Jauhkan diri dari sihir (senar ajaib, sulap, dan, ya, bahkan boolean ajaib).
- Tangkap efek kupu-kupu - apakah ada riak yang tidak terjawab (misal, penamaan yang tidak konsisten).
Bagian 3: Dongeng Reviewer: Pedoman untuk melakukan tinjauan kode
Bagian 4: Tinjau Seolah Anda Memiliki Kode