Dalam kehidupan seorang pengembang, momen datang ketika ia mulai melakukan tinjauan kode. Sebagai aturan, ini adalah salah satu tanda pertumbuhan seorang programmer: mereka mulai benar-benar mendengarkan pendapatnya dan memercayai tugas-tugas yang lebih serius. Saat yang tepat ketika pengembang diminta untuk melakukan peninjauan tergantung pada struktur perusahaan: ada tim di mana semuanya dapat dilakukan setelah beberapa waktu berlalu, dan ada juga yang proses peninjauannya sepenuhnya dilakukan oleh kolega yang paling senior dan berpengalaman.

Pada saat yang sama, beberapa orang berbicara tentang prinsip-prinsip apa yang harus diikuti untuk melakukan tinjauan kualitas: apa tujuan utama dari prosedur ini, apa yang harus dicari di tempat pertama, seberapa cepat itu perlu dilakukan.

Oleh karena itu, Panduan Tinjauan Google terlihat seperti dokumen yang sangat berharga, terjemahan dari bagian pertama disajikan nanti. Terjemahan bagian-bagian yang tersisa akan dirilis nanti di pos terpisah. Perlu dicatat bahwa ini adalah terjemahan yang disesuaikan, tidak semua diterjemahkan kata demi kata, atas nama formulasi dan kalimat Rusia yang lebih banyak.

Terminologi:

CL : "daftar perubahan" - daftar perubahan kode yang dikirim ke sistem kontrol versi untuk ditinjau. Analog Permintaan Tarik di GitHub atau Gabungkan Permintaan di GitLab.

1. Ulasan kode standar

Tujuan utama dari tinjauan ini adalah untuk meningkatkan basis kode Google. Semua alat dan cara yang digunakan untuk melakukan tinjauan ditujukan khusus untuk mencapai tujuan ini.

Dalam perjalanan untuk mencapai tujuan yang dinyatakan, kita harus membuat sejumlah kompromi.

Pertama, pengembang harus dapat melakukan tugasnya. Jika Anda tidak menerima perubahan apa pun pada basis kode, maka itu tidak akan pernah membaik. Dalam kasus ketika pengulas membuat perubahan terlalu rumit, pengembang tidak akan melakukan apa pun di masa depan.

, CL , . , . , .

, . , , , " ".

, , :

CL , , CL .

.

, : CL , , , .

, : , . CL , , CL , , . , , . CL, , , , .

, , , , . , , "Nit: ", .

: CL, . .

1.1.

- , , . , , - . , . , ( ), "Nit: " .

1.2.

• .
• style guide .
  , style guide . , .
• .
  / , . .
  , , , . .
• , , , , .

1.3.

, , , , : CL .

, : . , CL, .

, — , , , . CL "" , .

2.

: - .

2.1. ()

, — CL . CL? : ? ? ?

2.2.

CL , ? ? "" ( ), , .

, . , , , , , , .

, CL: , . , .

, — CL . , — . , , . ( ).

2.3.

CL — , , . , -, , -, .

, , , . , , , , . , .

2.4.

, , : , end-to-end . , CL, .
.

— , , .
, ? , ? , ? ?

, — , . , , .

2.5.

, . , , , , .

2.6.

, ? ? , , , , , : , . , . , , , : , .

, CL: , "TODO", , .

, — , . , .

2.7.

Google , . , CL .

, , ("Nit:"). CL .

CL . , . , , , CL — , .

2.8.

CL , , , , , README, g3doc (. — Google ) . CL , , . , .

2.9.

. , , , , . , - — . , .

, , , . Google . , , , , . , , , , .

, , , . , , , , .

2.10.

, , . , , : , , 4 , , 50 .

CL : CL , ?
CL, . , , CL.

2.11.

CL , : , . , , .

:

• ,
• ,
• : , ,
• ,
• ,
• ,
• ,
• , , ,
• , , ( ),
• (g3doc),
• -.

Anda harus melihat setiap baris kode, memperhitungkan konteksnya , pastikan Anda meningkatkan status basis kode dan mendorong keputusan pengembang yang berhasil.

Di bagian selanjutnya, kita akan membahas cara menavigasi yang lebih baik di CL dan di mana memulai ulasan.