Penamaan pembolehubah berdasarkan kod bersih

Kod Bersih ialah set beberapa konvensyen kod yang bersama-sama mencipta cara baharu menulis kod anda supaya lebih mudah dibaca, boleh diselenggara, dipercayai dan boleh diramal, menggalakkan kecekapan dan memudahkan kerja berpasukan .

Salah satu daripada beberapa prinsip kod bersih ialah menamakan pembolehubah dengan nama yang menerangkan sendiri dan menerangkan sendiri untuk mengelakkan kekaburan dan menulis kod yang lebih bersih, seorang pengarang hebat  Zeno Rocha berkata dalam bukunya 14 Tabiat Sangat Produktif Pembangun  kita harus sentiasa menulis kod yang boleh difahami oleh diri masa depan kita walaupun selepas bertahun-tahun. Menamakan pembolehubah dengan diminutif atau singkatan boleh membawa kepada tafsiran yang berbeza, terutamanya antara pembangun dengan tahap penglibatan yang berbeza dalam projek ini boleh membawa kepada masalah masa depan.

Adalah perkara biasa apabila asas kod berkembang dan pembolehubahnya diketepikan, terdapat keperluan untuk menyemak semula pada masa hadapan dan penulisan yang lemah akan menyukarkan untuk memahami kod anda yang membantu.

contoh pembolehubah buruk:

const date = new Date()
// Nome da varável é muito genêrica e não explica o que ela é

function getData(req, res) {}
// Nâo descreve bem o dado que ela está requisitando 

contoh pembolehubah yang baik:

const currentDate = new Date()
// Nome mais explicativo sobre o que ela é e menos genêrico

function getUserGithubCategory(req, res) {} 
// Descreve melhor o dado que a função está requisitando 

Masih dalam logik yang sama untuk menulis nama pembolehubah yang bermakna, kita sampai ke satu lagi perkara penting, iaitu apabila menulis pembolehubah Boolean yang mengikut arah penulisan yang sama, tetapi kita mesti menggunakan satu lagi peraturan kecil yang terkumpul kepada yang sebelumnya.

Dia mengatakan perkara berikut, kita harus menulis pembolehubah Boolean seolah-olah ia adalah sejenis soalan yang boleh dijawab dengan ya atau tidak, ini kerana pembolehubah Boolean hanya boleh menerima benar (ya) atau palsu (tidak) dan soalan untuk menyatakan sama ada mereka aktif atau tidak membantu membaca kod.

contoh tanpa menggunakan peraturan:

const ticketPark = user.ticketPark 

if (!ticketPark ) {
  throw new Error('O Marcos não possui um bilhete para entrar no parque!')
}

contoh dengan penggunaan peraturan:

const hasUserTicket = user.hasTicket // o usuário tem o ticket ?

if (!hasUserTicket) { // se o usuário não tiver o ticket 
  throw new Error('O Marcos não possui um bilhete para entrar no parque!')
}

Adakah anda bersetuju dengan saya bahawa apabila menggunakan model penamaan pembolehubah Boolean ini ia tidak menjadikan bacaan lebih mudah dengan mengatakan bahawa jika pengguna mempunyai tiket, dia boleh pergi ke tunggangan dan bukannya hanya menyemak bahawa tiket taman itu tidak palsu? Menggunakan jenis ini benar-benar boleh meningkatkan pemahaman pihak ketiga tentang kod anda dan membantu anda mengelakkan kekaburan juga.

Akhir sekali, kami hanya mempunyai satu lagi peraturan mudah yang mengiringi dua yang terakhir ini, yang, selain menulis kod anda dengan lebih baik, adalah menggunakan pembolehubah untuk menyimpan "nombor ajaib" dalam kod anda. Tetapi selepas semua, apakah nombor ajaib ini dalam kod anda? Secara amnya, ramai pengaturcara, apabila menggunakan peraturan perniagaan pada projek mereka, menggunakan pelbagai nombor untuk melaksanakan beberapa operasi dalam kod dan yang seterusnya dilemparkan ke dalam kod tanpa perlu mempunyai sebarang penjelasan tentang sebab ia berada di sana.

contoh kod yang penuh dengan nombor ajaib:

const date = new Date()
// Nome da varável é muito genêrica e não explica o que ela é

bolehkah anda memahami untuk apa kod itu?

Sukar dengan nombor yang tidak dapat digambarkan ini, bukan?

pernahkah anda mendengar frasa ini "Saya tidak tahu mengapa lagi jika anda mengalih keluar kod itu rosak"? Ia mewakili dengan baik apa yang saya ingin katakan di sini, elakkan membiarkan nombor ini longgar dan tanpa penjelasan mengapa ia berada di sana, jika tidak mungkin untuk menjelaskannya dalam pembolehubah, buat ulasan ringkas mungkin wujud dalam kod anda.

Lihat bagaimana kod ini harus ditulis:

function getData(req, res) {}
// Nâo descreve bem o dado que ela está requisitando 

Sekarang lebih baik, bukan?

Faedah

Mengguna pakai amalan seperti menamakan pembolehubah dengan jelas, mengelakkan nombor ajaib dan mengikuti prinsip Kod Bersih bukan sahaja meningkatkan kualiti kod anda, tetapi juga memudahkan untuk bekerjasama dengan pembangun lain dan mengekalkan dalam jangka panjang.

Ingat: menulis kod bersih bukan tentang mencapai kesempurnaan, ini tentang menjadikan kod lebih mudah diakses, difahami dan boleh diramalkan untuk semua orang yang menggunakannya, termasuk anda pada masa hadapan.

Cuba gunakan peraturan ini pada projek anda yang seterusnya dan perhatikan perbezaannya! Kongsi petua ini dengan rakan sekerja atau pasukan anda untuk mewujudkan persekitaran kerja yang lebih produktif dan cekap. Lagipun, kod yang ditulis dengan baik ialah langkah pertama untuk membina perisian berkualiti tinggi.

Jadi, bagaimana pula bermula hari ini? Tulis kod yang anda akan berbangga untuk membaca pada masa hadapan!

Atas ialah kandungan terperinci Penamaan pembolehubah berdasarkan kod bersih. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!