Jika ragu, jelaskan.
Inti dari nama variabel adalah agar makna kode lebih jelas. Kecuali jika singkatannya sangat jelas, maka Anda mungkin hanya menggunakan yang terkecil. Nama variabel dan nama fungsi biasanya merupakan satu-satunya bagian dari bahasa manusia dalam kode dan bertindak sebagai 'landmark' bagi mata manusia untuk menemukan bagian kode yang relevan (atau, dalam basis kode besar, alat seperti grepatau ack) dan juga sebagai petunjuk untuk pemahaman.
Ketika orang berikutnya datang untuk membaca kode Anda, mereka akan berterima kasih untuk itu. Orang itu bisa jadi Anda dalam waktu satu tahun. Saya memiliki banyak kode yang saya sesalkan, jadi sekarang saya mencoba menghindarinya.
Tidak apa-apa untuk menyingkat ketika ...
... Ketika bentuk singkatan digunakan dalam bahasa Inggris lisan atau tulisan oleh lebih dari sekedar orang yang mengerjakan proyek Anda (banyak kamus memberikan informasi semacam ini di sebelah istilah yang mereka tetapkan).
var extensible_markup_language_element; // don't do this
var xml_element; // better
var element; // possible if the name of the function or the documentation make it clear you're dealing with XML and not the periodic table
docs.toString(); // most people capable of reading code know docs == documentation
... Ketika singkatan merujuk dengan jelas ke satu konsep dan akan langsung dikenali oleh seseorang yang tidak terbiasa dengan basis kode. Bahkan kemudian komentar atau sepotong dokumentasi membantu.
var auth = user.auth;
if (auth) // If the user is authenticated?
// If the user is authorised to do something?
// If the authentication function exists for that user group?
// If some setting called auth is turned on for that user?
// If the user is the author of the document in question?
// If the user has some authority?
var attrNames = retrieveAttrs();
if (attrNames) // hm, attrNames sounds like an array of strings - which will be boolean true even if empty - this if looks like a bug!
const MDF // author is writing an iOS app for ordering hand-carved artisanal fibreboard so anyone familiar with the problem domain knows this has plainly nothing to do with Microsoft Database Files. Though maybe the first time it comes up in the code the author should perhaps still put its full name
... Ketika nama variabel hanya ada dalam lingkup tunggal atau fungsi kecil, dan Anda tidak mengharapkan pengguna untuk mendapatkan makna dari nama, gunakan satu karakter. Dalam kasus seperti itu, idan jumum terjadi.
foreach $i (1..10) { say $announcement->[$i] }
... Saat menulis antarmuka (yaitu bukan nama variabel, jadi di luar lingkup pertanyaan, disebutkan hanya karena nama variabel dan antarmuka yang mengaturnya sering menggunakan kosakata yang sama) dalam hal ini aturan lain mungkin berlaku, misalnya:
some_command --transaction-message "Done" # a bit wordy - keep, but ALSO allow for convenience:
some_command --msg "Done" # might be useful
some_command -m "Done" # if you can spare -m
... Ketika basis kode Anda perlu merujuk ke konsep yang sama berkali-kali dalam proyek yang sama dan ketika singkatan dapat didefinisikan dalam panduan gaya untuk proyek itu, dan ketika itu tidak ambigu. Jika proyek Anda tidak cukup besar untuk panduan gaya maka itu tidak cukup besar untuk itu layak.
Saya tidak akan memberikan contoh kode untuk yang ini karena menurut definisi itu hanya berfungsi dalam proyek besar, tetapi lihat juga item berikutnya:
... Saat mengerjakan proyek mapan yang memiliki banyak kontributor dan panduan gaya yang mengharuskan singkatan. Dalam hal ini, disingkat hanya sesuai dengan panduan gaya, tetapi perhatikan masalah dan bersiaplah untuk membuat catatan dengan komentar (seperti "ini adalah daftar nama atribut sebagai string").
Jenis harus diakhiri dengan “_t”; Definisi struct mentah dalam “_struct”
- https://metacpan.org/source/SHLOMIF/XML-LibXML-2.0117/HACKING.txt
Satu pemikiran terakhir: jika Anda masih memiliki nama variabel panjang yang tidak dapat diterima (mis. Terdiri dari empat atau lebih unit semantik seperti totalAfterTaxInLocalCurrency), itu bisa menjadi gejala bahwa kode Anda mencoba melakukan terlalu banyak dalam satu cakupan tunggal dan fungsinya perlu direaktor ulang keluar atau variabel Anda mungkin lebih dikelola secara logis dalam satu objek.