PHP Master | Kepentingan Kajian Kod

3

Kunci Takeaways

Kajian Kod adalah pemeriksaan sistematik kod sumber komputer, yang bertujuan untuk mencari dan memperbaiki kesilapan yang diabaikan dalam fasa pembangunan awal, sehingga meningkatkan kualiti perisian dan kemahiran pemaju keseluruhan. Ia boleh dilakukan dalam pelbagai bentuk seperti pengaturcaraan pasangan, panduan tidak rasmi, dan pemeriksaan rasmi.
• Kajian Kod bukan sahaja mengurangkan jumlah kecacatan dalam kod tetapi juga meningkatkan kerjasama, membantu membina pasukan, meningkatkan "persaudaraan" di kalangan pemaju, dan menyebarkan amalan terbaik dan peningkatan kemahiran di seluruh pasukan atau jabatan.
Amalan Terbaik untuk Kajian Kod termasuk mengetahui kesilapan yang sama dan secara aktif melawan mereka, mempunyai kod yang dikaji semula oleh seseorang yang mempunyai kemahiran yang sama atau lebih besar, mengkaji semula kod yang kurang dengan tonggak yang jelas, mengumpul metrik, dan menyedari aspek sosial di mana mencari pepijat adalah baik , tidak buruk.
• Artikel ini menekankan pentingnya tidak melihat kajian semula kod sebagai negatif atau membuang masa tetapi sebagai peningkatan aliran kerja seharian. Ia mencadangkan bahawa jika pasukan anda tidak menggunakannya hari ini, mencadangkannya, kerana sebarang jenis semakan kod lebih baik daripada tiada.

Setiap pemaju tahu kesakitan kesilapan. Atribut yang salah di sini, harta yang salah eja di sana, satu kod kod yang tidak disengajakan yang anda terlepas kerana hackathon 16 jam yang dibakar kopi yang telah anda lakukan. Malah $ yang mudah sebelum tag php pembukaan yang anda tidak sengaja meletakkan di sana kerana anda mula menaip sebelum IDE berasaskan Java infernal menghangatkan dan meletakkan semula kursor boleh membuatkan anda menggaru kepala anda selama berjam-jam jika anda letih dan terganggu . Sekiranya anda mempunyai sepasang mata yang segar untuk melihat apa yang anda lakukan - pasti kesilapan -kesilapan ini dapat dielakkan dengan mudah? Wikipedia mentakrifkan Kajian Kod seperti berikut: Kajian Kod

adalah pemeriksaan sistematik (sering dikenali sebagai kajian semula rakan sebaya) kod sumber komputer. Ia bertujuan untuk mencari dan memperbaiki kesilapan yang diabaikan dalam fasa pembangunan awal, meningkatkan kualiti keseluruhan perisian dan kemahiran pemaju. Ulasan dilakukan dalam pelbagai bentuk seperti pengaturcaraan pasangan, jalan keluar tidak rasmi, dan pemeriksaan rasmi.

Takrif ini adalah tepat kerana ia mendapat - dalam lebih banyak istilah awam, kajian kod hanyalah tindakan yang mempunyai orang lain melihat kod anda untuk mencari kesilapan yang anda rindukan.

Jenis Kajian Kod

Memandangkan definisi Wikipedia menunjukkan, terdapat banyak cara yang berbeza untuk mengkaji semula kod untuk kecacatan. Berikut adalah pemecahan cepat beberapa daripada mereka:

• OTS (over the bahu) Kajian - Ini adalah bagaimana pasukan kecil biasanya mengendalikan ulasan kod. Seorang pemaju akan menulis jumlah kod yang baik dan memanggil pemaju lain untuk melihatnya. Pemaju lain duduk di sana sementara yang pertama menerangkan apa yang dilakukannya, garis demi baris. Melalui naratif ini, pemaju asal melihat beberapa kesilapannya sendiri dan membetulkannya, dan pemaju OTS melihat orang lain, menunjuk mereka kepada yang pertama. Mereka juga berkongsi pendapat mengenai penyelesaian kepada masalah tertentu yang mana pemaju asal kadang -kadang akan mengulangi selepas proses semakan dilakukan, memanggil semakan sekali lagi. Ini juga boleh dilakukan dengan mudah dengan perisian perkongsian skrin dan sembang suara jika pemaju jauh.
• Kajian Alat yang Dibantu-Terdapat pelbagai alat dalam talian dan luar talian untuk membantu kajian semula kod. Walaupun melihat terperinci mengenai pelbagai alat yang ditawarkan adalah di luar skop artikel ini, kita dapat umum dan mengatakan terdapat versi berbayar (Atlassian Crucible, CodeCollaborator), versi percuma (Lembaga Kajian) atau, jika anda pemaju solo, Versi Komuniti (Kajian Kod Exchange Stack). Terlepas dari alat yang digunakan, masing -masing berfungsi dengan tujuan yang sama - ia mengambil perubahan yang paling terkini kepada kod sumber dan bendera mereka sebagai memerlukan semakan. Seorang rakan sebaya - yang bermaksud pemaju kemahiran yang sama atau lebih besar - kemudian mengkaji semula kod, bendera itu sebagai dikaji semula atau menandakan sebarang kesilapan yang ditemui dan membuat cadangan, dan sama ada selesai atau menghidupkan semula proses dengan menghantarnya kembali kepada pemaju yang berasal. Ia juga penting untuk diperhatikan bahawa banyak IDE popular mempunyai plugin ulasan kod.
• Pengaturcaraan pasangan - Jenis kajian kod yang sangat dinamik, pengaturcaraan pasangan adalah "permainan" hotseat untuk dua pemaju di mana satu kod pemaju dan yang lain mengikuti kemajuannya dengan duduk di sebelahnya. Selepas beberapa ratus baris kod atau selepas mereka mencapai kejayaan yang telah ditetapkan, mereka mengambil rehat pendek dan beralih tempat. Orang yang sedang mengodkan kini memerhatikan sementara orang yang sebelum ini diperhatikan sekarang kod. Ini sangat berkesan dalam mengelakkan pepijat dan meningkatkan kualiti kod keseluruhan, tetapi kos dua kali tenaga kerja. Banyak syarikat tidak bersedia untuk risiko sedemikian dan malangnya tidak dapat berfikir dari segi selain daripada "dua orang di dua mesin melakukan lebih banyak kerja daripada dua orang pada satu mesin". Ini adalah jenis kajian jenis yang menghasilkan hasil yang terbaik: bukan sahaja pepijat dielakkan secara rata, tetapi kedua -dua pemaju secara langsung bekerjasama dan berkongsi idea mengenai penyelesaian kepada masalah yang mereka hadapi ketika mereka maju. Ia juga tidak bernilai apa -apa jenis kajian ini sangat sukar untuk dilaksanakan dalam pasukan yang tidak digunakan untuknya - ia kebanyakannya berfungsi pada pasukan yang lebih muda.

Di samping itu, terdapat juga jenis kajian rasmi, yang pertama kali diperkenalkan dan diteliti oleh Michael Fagan pada tahun 1970 -an (kaedah ini juga dikenali sebagai pemeriksaan Fagan), kini agak kuno dan tidak disukai dalam industri. Pemeriksaan formal jarang digunakan dalam pasukan kecil dan kebanyakannya berkaitan dengan produk beberapa juta dolar kerana ia sangat sengit dan mahal. Ia termasuk beberapa orang (sehingga enam) duduk dengan projektor dan mengkaji semula kod bersama. Setiap peserta diberikan peranan (seperti pembaca, moderator, atau pengulas) dan apabila pasukan notis bug atau kecacatan apa -apa jenis, semuanya terperinci ke tahap yang besar - dari keparahan, ke baris sebenar kod, kepada penyebabnya dan Kesan, walaupun kos yang diramalkan bug ini menjangkau pelanggan. Ini adalah jenis kajian kod yang paling profesional, tetapi juga yang paling mengecewakan kepada pemaju dan dengan demikian tidak diterima pakai secara meluas. Kajian telah menunjukkan kaedah kajian semula kod lain yang sama berkesan jika digunakan dengan betul, tanpa perlu mengikat banyak orang begitu lama.

Amalan Terbaik untuk Kajian Kod

Sebaik sahaja ia telah diputuskan untuk melaksanakan kajian semula kod, mungkin terdapat beberapa halangan untuk diatasi. Pengurusan mungkin tidak melihat justifikasi untuk semakan masa tambahan yang diperlukan, atau sesetengah pengaturcara mungkin berfikir semakan adalah serangan peribadi terhadap kod yang mereka bekerja keras untuk dicipta. Berikut adalah beberapa petua yang akan anda ingat dengan baik apabila kajian kod dilaksanakan.

1. Ketahui kesilapan biasa anda dan secara aktif melawan mereka. Ketika bekerja, setiap pemaju mempunyai kesilapan yang biasanya dibuatnya tidak kira betapa mendalamnya "di zon" dia. Setiap orang kita mempunyai gangguan kecil yang hanya bodoh dan diperhatikan secara langsung oleh orang lain. Perhatikan slip-up ini. Lupa untuk menapis input ... lagi? Lupa untuk memberi komen kaedah ... lagi? Dengan senarai seperti itu, pemaju boleh secara aktif memburu kesilapan tersebut sebelum memanggil semakan. Ini dikenali sebagai kesan ego - anda tahu kod anda akan dikaji semula dan anda tidak mahu mendengar pengulas yang mengatakan "Aw man, anda terlupa untuk menapis input lagi!" Anda mahu menjadi Rockstar, Ninja, orang yang membuat orang lain berkata "Wow, itu sebenarnya penyelesaian yang hebat". Kesan ego adalah apa yang akan mendorong anda untuk memperbaiki kod anda sebelum orang lain bahkan mempunyai peluang untuk melihatnya. Kajian Kod Peer Peer Code bermaksud dikaji semula oleh seseorang yang mempunyai kemahiran yang sama atau lebih besar. Seperti yang sepatutnya masuk akal, semakan kod tidak boleh berfungsi apabila junior mengkaji semula kod senior. Junior mungkin melihat beberapa percanggahan biasa, pelanggaran standard, kesilapan, atau bahkan kesilapan seperti penapisan input, tetapi biasanya tidak dapat mengenal pasti masalah yang lebih besar. Ini sering memerlukan definisi hierarki dengan kemahiran dalam pasukan jika seseorang belum hadir.
2. Kurang kod dengan pencapaian yang jelas bermakna ulasan yang lebih baik. Kod harus dikaji semula hanya selepas peristiwa penting telah dicapai, dan tonggak -tonggak ini harus kecil dan harus sering terjadi. Dalam pengaturcaraan berorientasikan objek ini amat penting, tetapi juga boleh dilakukan. Selesai komponen baru yang memanjangkan antara muka yang mengikat ke dalam penyesuai yang telah dikaji semula? Akhirnya menetapkan masalah dengan kaedah tertentu yang mengganggu jabatan selama seminggu? Hebat! Komponen oleh komponen, dan menyimpannya sehingga maksimum 700-800 baris kod pada satu masa (komen termasuk) adalah apa yang menghasilkan proses semakan yang paling efisien mutlak. Pastikan kod yang anda perlukan disemak pendek, ringkas dan bebas dan lakukan semakan secepat mungkin selepas selesai sementara idea -idea masih segar dalam fikiran anda. Hanya ingat - masa mahal, jadi jangan ambil terlalu banyak sama ada! Satu jam harus lebih daripada cukup untuk melaksanakan "semakan bahagian" ini.
3. Kumpulkan metrik. Ini lebih mudah jika anda menggunakan jenis kajian semula yang lebih berstruktur seperti alat yang dibantu atau formal, tetapi boleh dilakukan di OTS juga. Cuba perhatikan nombor dan jenis pepijat dan slip-up yang anda dapati melalui beberapa baris kod dan unit masa. Agregat data ini merentasi pemaju dan dengan mudah mengetahui siapa yang memerlukan bantuan yang paling, yang melanggar piawaian yang paling banyak dan berapa banyak wang yang sebenarnya anda simpan dengan syarikat anda dengan melakukan semakan kod. Tidak lama lagi, anda akan dapat mengkuantifikasi kegunaan semakan kod, dan hanya semua orang dalam syarikat itu menjadi aktif tertarik dengannya. Ini biasanya merupakan bahagian yang paling sukar untuk dilaksanakan, kerana beberapa pemaju mempunyai kesabaran untuk statistik manual, tetapi ia boleh bermanfaat jika diterima pakai.
4. Berhati -hati dengan aspek sosial - mencari pepijat adalah baik, tidak buruk! Adalah penting untuk diingat bahawa mencari bug adalah baik, tidak buruk. Jangan sekali -kali menafikan atau membuang pemaju yang membuat kesilapan, menjadikannya tidak rasmi. Minta orang menyesuaikan diri dengan Kajian Kod - Bantu rakan -rakan anda menerimanya, tidak takut. Kajian Kod bukan sahaja berguna - ia juga boleh menjadi menyeronokkan. Ingat bahawa lebih banyak masa dan tugas yang lebih sukar sama dengan lebih banyak pepijat - bilangan bug tidak menunjukkan kemahiran pemaju! Jika anda seorang pengurus atau ketua pasukan, pastikan tiada siapa yang melihat kajian semula kod sebagai negatif atau membuang masa. Pastikan mereka tidak melihatnya sebagai peraturan yang dikuatkuasakan oleh syarikat tetapi sebagai peningkatan kepada aliran kerja sehari -hari mereka yang mereka harus menyimpan tanpa mengira syarikat yang mereka kerjakan. Sekiranya mungkin, berusaha untuk pendekatan peribadi kajian semula kod. Jika anda menggunakan alat, gunakannya dalam OTS juga. Pendekatan peribadi brainstorming bersama dan perbincangan tidak rasmi mengenai penyelesaian yang berpotensi untuk masalah adalah tidak ternilai dalam proses menerima kajian semula kod sebagai rakan anda.

Kesimpulan

Kajian semula kod boleh menjadi sangat sukar untuk dilaksanakan, terutamanya dalam satu pasukan lama yang tidak digunakan untuknya. Tetapi apabila selesai, ia bukan sahaja akan mengurangkan jumlah kecacatan dalam kod anda, ia juga akan meningkatkan kerjasama dan membantu membina pasukan, meningkatkan "persaudaraan" di kalangan pemaju dan akan menyebarkan amalan terbaik dan peningkatan kemahiran di seluruh pasukan atau jabatan. Mana -mana jenis semakan kod adalah lebih baik daripada tiada, jadi jika pasukan anda tidak menggunakannya hari ini, cadangkannya. Ia hanya dapat membantu. Jika anda seorang pemaju solo, cari semangat kerabat untuk mengkaji semula kod dengan - pergi dalam talian, bersosial, memperluaskan kalangan pembangunan anda, bekerjasama. Jangan melihat pemaju lain sebagai persaingan dan kajian semula kod sebagai musuh anda, lihat orang lain seperti Brothers in Arms dengan Kajian Kod sebagai senjata anda di barisan depan untuk kesempurnaan. imej melalui Fotolia

Soalan Lazim mengenai Kajian Kod

Apakah kepentingan kajian semula kod dalam pembangunan perisian? Ia membantu mengekalkan kualiti kod standard yang tinggi, memastikan bahawa kod itu boleh dibaca dan difahami oleh orang lain, dan memupuk perkongsian pengetahuan di kalangan pasukan. Kajian Kod juga membantu menangkap dan memperbaiki pepijat awal dalam proses pembangunan, mengurangkan kos dan masa pembetulan pepijat di peringkat kemudian.

Apakah amalan terbaik untuk menjalankan kajian kod? > Beberapa amalan terbaik untuk menjalankan kajian kod termasuk memahami konteks kod, yang memberi tumpuan kepada logik dan struktur kod dan bukannya gaya pengekodan, memberikan maklum balas yang membina, dan tidak tergesa -gesa proses semakan. Ia juga penting untuk melibatkan orang yang betul dalam proses semakan, biasanya mereka yang biasa dengan codebase dan ciri khusus yang dikaji semula. Untuk membuat semakan kod anda lebih berkesan, anda harus memastikan bahawa kod anda jelas, didokumentasikan dengan baik, dan mengikuti piawaian pengekodan pasukan anda. Anda juga harus memecahkan perubahan anda ke dalam ketulan kecil dan terkawal yang lebih mudah dikaji semula. Di samping itu, menggunakan alat semakan kod dapat membantu menyelaraskan proses semakan dan menjadikannya lebih efisien. Sertakan tidak mengkaji semula kod dengan teliti, memfokuskan terlalu banyak pada gaya pengekodan dan bukannya logik dan struktur kod, tidak memberikan maklum balas yang membina, dan bergegas proses semakan. Ia juga merupakan kesilapan untuk tidak melibatkan orang yang betul dalam proses semakan.

Apakah beberapa alat semakan kod yang baik untuk PHP?

Terdapat beberapa alat semakan kod yang baik untuk PHP, termasuk php_codesniffer, pengesan kekacauan PHP, dan sonarqube. Alat ini dapat membantu mengautomasikan proses semakan kod, menangkap kesilapan pengekodan biasa, dan menguatkuasakan piawaian pengekodan. Pastikan ia bersih, didokumentasikan dengan baik, dan mengikuti piawaian pengekodan pasukan anda. Anda juga harus memecahkan perubahan anda ke dalam ketulan kecil dan terkawal yang lebih mudah dikaji semula. Di samping itu, anda harus memberikan ringkasan yang jelas dan ringkas tentang perubahan anda untuk membantu pengulas memahami konteks kod anda. Dalam kajian semula kod, anda harus memberi tumpuan kepada kod, bukan orang itu. Jadilah khusus dan jelas dalam komen anda, dan berikan cadangan untuk penambahbaikan. Ia juga penting untuk menjadi hormat dan profesional dalam maklum balas anda.

bagaimana saya dapat mengendalikan maklum balas dalam kajian kod? tidak mengambil maklum balas secara peribadi. Pertimbangkan maklum balas sebagai peluang untuk belajar dan meningkatkan kemahiran pengekodan anda. Sekiranya anda tidak bersetuju dengan komen, bincangkannya dengan pengulas untuk memahami perspektif mereka. projek. Walau bagaimanapun, secara amnya disyorkan untuk menjalankan ulasan kod secara teratur, seperti sekali seminggu atau untuk setiap ciri utama atau pembetulan pepijat. Kajian kod biasa boleh membantu menangkap dan memperbaiki pepijat awal dalam proses pembangunan. Mereka memupuk perkongsian pengetahuan di kalangan pasukan, membantu mengekalkan gaya pengekodan yang konsisten merentasi asas, dan mewujudkan budaya pemilikan kod kolektif. Kajian Kod juga memberi peluang kepada pemaju junior untuk belajar dari ahli pasukan yang lebih berpengalaman.

Atas ialah kandungan terperinci PHP Master | Kepentingan Kajian Kod. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!