Daripada Kekacauan kepada Kejelasan: Memformat Kod Reaksi untuk Pangkalan Kod yang Bersih dan Boleh Dibaca

Apabila memulakan projek baharu, terdapat pengalaman yang sangat biasa dalam kalangan pembangun React. Anda mula berasa gembira tentang betapa bersih dan boleh dibaca kod anda, hanya untuk menulis segelintir fungsi atau komponen dan perlahan-lahan melihat pangkalan kod anda menjadi huru-hara. Anda mendapati diri anda menatal dari atas ke bawah, kiri ke kanan, membaca semula baris kod berulang kali dan bergerak dari fail ke fail. Sebaik sahaja anda menyelesaikan fungsi, anda berharap tidak perlu membuka fail itu lagi kerana anda tahu berapa lama masa yang diperlukan untuk mencari hanya satu fungsi atau pembolehubah—apalagi mengedit atau menukar fungsi tersebut.

Dalam artikel ini, kami akan mengkaji peranan pemformatan dalam menjadikan pangkalan kod anda bersih dan boleh dibaca. Kami juga akan meneroka piawaian industri dan amalan terbaik untuk mencapai pemformatan yang konsisten.

Mengapa Memformat kod anda?

Pemformatan adalah penting untuk kebolehbacaan dan kebolehselenggaraan kod anda. Tetapi bagaimana?

Kod yang diformat dengan baik membantu memisahkan bahagian kod anda secara visual, menjadikannya lebih mudah untuk mengikuti aliran logik. Lekukan yang betul menyerlahkan hubungan antara komponen, elemen atau pemilih ibu bapa dan anak. Pemformatan yang konsisten meningkatkan keupayaan anda untuk nyahpepijat, membetulkan dan mengekalkan kod anda dengan cepat. Apabila bekerjasama dengan ahli pasukan yang mengikut peraturan pemformatan yang sama, lebih mudah untuk memahami kod satu sama lain tanpa kekeliruan.

Mengurangkan beban mental ialah satu lagi faedah pemformatan yang baik. Kod bersih memerlukan usaha mental yang kurang untuk memahami, membolehkan anda menumpukan lebih pada menyelesaikan masalah baharu dan bukannya mentafsir blok kod yang tidak diformatkan dengan baik.

Apabila pasukan mematuhi gaya yang konsisten, semua orang boleh menyumbang tanpa membuang masa memformat semula sekatan kod untuk disesuaikan dengan pilihan peribadi. Pemformatan yang baik juga membawa disiplin dan profesionalisme kepada pangkalan kod.

Akhir sekali, keserasian alatan adalah kelebihan yang ketara. Pembangun menggunakan linter, alat tambah dan IDE yang bergantung pada pemformatan yang konsisten. Untuk memanfaatkan sepenuhnya alatan ini dan mendapat manfaat daripada ciri seperti pelengkapan automatik dan penyerlahan ralat, pangkalan kod anda memerlukan pemformatan yang betul. Tetapi bagaimana anda mencapainya?

Apakah yang terlibat dalam memformat pangkalan kod?

Apabila bercakap tentang pemformatan pangkalan kod, kami biasanya merujuk kepada beberapa aspek: Lekukan, Panjang Baris, Konvensyen Penamaan, Jarak, Pendakap dan Kurungan, Penggunaan Petikan yang konsisten, penggunaan titik bertindih, Struktur Fail dan Folder dan penggunaan yang sesuai Komen. mari kita masuk ke dalam piawaian industri tentang cara ini digunakan dan dilaksanakan.

1. Lekukan
   Lekukan ialah penggunaan ruang putih untuk menyusun kod secara visual ke dalam hierarki. Standard industri di sini ialah menggunakan 2 atau 4 ruang dan elakkan menggunakan tab. Menurut panduan gaya Airbnb untuk javascript dan bertindak balas, anda harus menggunakan 2 ruang. Ini kerana ia mengekalkan tahap sarang yang konsisten dan meningkatkan kebolehbacaan keseluruhan kod anda.

2. Panjang Garisan
   Panjang baris di sini merujuk kepada sejauh mana kod yang anda tulis pada satu baris harus dilanjutkan. Standard industri di sini adalah untuk mengekalkan garis antara 80 hingga 100 aksara. Banyak panduan terutamanya PEP 8 dan lebih cantik mengesyorkan 80 aksara. Ini kerana ia menghalang penatalan mendatar dan ia biasanya berfungsi dengan baik pada saiz skrin yang berbeza. tetapi adakah ini bermakna perlu mengira sebagai kod anda? tidak, sekurang-kurangnya tidak apabila anda menggunakan editor kod seperti vscode. Imej di bawah menunjukkan anda cara untuk mengetahui bilangan aksara pada baris tertentu. Imej di bawah menunjukkan bahawa anda berada pada baris 44 dan berada pada aksara ke-93. anda boleh menemuinya di bahagian bawah sebelah kanan pada editor vsCode anda jika anda belum menyentuh tetapan lalai.

1. Konvensyen Penamaan
   
   Ini merujuk kepada satu set peraturan untuk menamakan sesuatu dengan cara yang konsisten. Penamaan yang jelas, bermakna dan tepat adalah penting untuk menulis kod yang mudah dibaca, difahami dan diselenggara. Konvensyen penamaan yang paling popular untuk pembolehubah dan fungsi ialah menggunakan camelCase(cara untuk memisahkan perkataan dalam frasa dengan membuat huruf pertama setiap perkataan dengan huruf besar dan tidak menggunakan ruang). Bagi komponen tindak balas PascalCase harus digunakan terutamanya kerana huruf Pertama komponen haruslah huruf besar seperti yang dinyatakan dalam Dokumen tindak balas dan Untuk pemalar huruf atas ular disyorkan. Bahagian ini tidak melakukan penamaan keadilan. Jika saya perlu menamakan secara mendalam di sini artikel ini akan menjadi terlalu panjang. Jika anda berminat untuk mengetahui lebih lanjut sila semak artikel mengenai konvensyen penamaan ini.

2. Jarak
   Untuk Spacing disyorkan untuk menambah ruang di sekeliling operator untuk kejelasan terutamanya kerana pengendali tertentu apabila digunakan dalam kombinasi melakukan operasi yang berbeza. adalah juga disyorkan bahawa baris kosong digunakan untuk memisahkan bahagian logik kod. cuba kumpulkan dan gunakan ruang baris kosong pengisytiharan pembolehubah dan tugasan daripada pengisytiharan fungsi dan logik.

3. Pendakap dan Kurungan
   Menurut Panduan gaya Airbnb, tiada pendakap berjuntai yang bermaksud anda harus memastikan semua pendakap tutup atau kurungan sejajar dengan pendakap bukaan atau kurungan yang sepadan.

4. Petikan Konsisten
   Apabila menggunakan petikan adalah disyorkan untuk menggunakan sama ada petikan tunggal '' atau petikan berganda "" sepanjang projek sambil cuba mengelakkan sebarang penggunaan gabungan kedua-duanya yang tidak perlu.

5. Koma bertitik
   Sama seperti petikan, tekadkan anda sama ada menggunakan koma bertitik untuk menamatkan ungkapan, tugasan dan baris kod anda atau tidak menggunakan koma bertitik sama sekali tetapi apa sahaja keputusan anda, sila berpegang padanya dan konsisten. Saya secara peribadi akan mengesyorkan penggunaan titik bertitik untuk mengelakkan isu yang datang dengan sisipan titik bertitik automatik.

6. Struktur Fail dan Folder
   Untuk faktor struktur fail dan folder seperti saiz projek dan tindanan teknologi kebanyakannya menentukan struktur fail dan folder anda namun terdapat 2 peraturan am yang perlu dipatuhi. 1 Kumpulan fail berkaitan bersama-sama. 2 gunakan nama fail yang bermakna.

7. Ulasan
   Pangkalan kod dengan mudah boleh dikelompokkan dengan kod jadi jangan memburukkannya dengan menggunakan komen secara berlebihan. jika anda mempunyai konvensyen penamaan yang baik dan menulis kod bersih yang tidak mempunyai anti-corak, anda sepatutnya dapat mengelak daripada menggunakan ulasan. Sama seperti Robert c. Martin berkata "komen sememangnya tidak buruk", tetapi ia selalunya "tanda kegagalan untuk menyatakan niat dalam kod itu sendiri". Komen mempunyai tempat dalam kod anda, ia menunjukkan sebab kod wujud bukan cara blok kod berfungsi , jadi ulasan harus digunakan jika kod anda melibatkan keputusan yang tidak jelas atau penyelesaian. jadi elakkan anti-corak untuk menghapuskan keperluan untuk menerangkan cara kod anda dan elakkan menerangkan perkara yang telah dinyatakan oleh kod itu.

Di bawah ialah pautan kepada beberapa panduan gaya tetapan industri

Panduan Gaya Javascript Airbnb.
Panduan Gaya StandardJs
Prettier Default
.

Jadi kesimpulannya Memformat kod anda dengan betul bukan hanya untuk estetik. Ia secara drastik meningkatkan kebolehbacaan, kebolehselenggaraan dan kebolehskalaan pangkalan kod anda dan dengan Mengguna pakai piawaian industri popular anda boleh memastikan kod anda konsisten dan bersih

Atas ialah kandungan terperinci Daripada Kekacauan kepada Kejelasan: Memformat Kod Reaksi untuk Pangkalan Kod yang Bersih dan Boleh Dibaca. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!