Salah eja yang disengaja untuk menghindari kata-kata yang dipesan

Saya sering melihat kode yang menyertakan kesalahan ejaan kata-kata umum yang disengaja menjadi lebih baik atau lebih buruk:

• klassatau clazzuntuk kelas :Class clazz = ThisClass.class
• kountuntuk hitungan dalam SQL:count(*) AS kount

Secara pribadi saya menemukan ini mengurangi keterbacaan. Dalam praktik saya sendiri, saya belum menemukan terlalu banyak kasus di mana nama yang lebih baik tidak dapat digunakan - itemClassatau recordTotal.

Contoh dari JavaDocs untuk Kelas menunjukkan ini di parameter:

 public <U> Class<? extends U> asSubclass(Class<U> clazz)

Apakah ini menunjukkan penggunaan yang wajar?

IMHO, ini ide yang sangat buruk. Kata-kata yang dicadangkan dicadangkan karena suatu alasan, dan melakukan hal ini mengurangi keterbacaan.

Saya juga sepenuhnya setuju dengan poin kedua Anda. Memberi nama variabel class, bahkan jika Anda bisa melakukannya, akan sama buruknya dengan memberi nama tmpatau a. Kelas macam apa? Kelas apa? Nama harus deskriptif.

Panduan Gaya Python menyebutkan masalah ini secara khusus, dan menyarankan:

Jika nama atribut publik Anda bertabrakan dengan kata kunci yang dipesan, tambahkan satu garis bawah garis bawah pada nama atribut Anda. Ini lebih disukai daripada singkatan atau ejaan yang rusak.

Ini sepertinya aturan umum yang cukup bagus, dengan asumsi itu tidak bertentangan dengan semantik bahasa tertentu.

Bau kode.

string stringVariable = "";

Kode di atas tidak memberi tahu saya apa pun tentang penggunaan variabel yang dimaksudkan.

class Klass

Permasalahan yang sama

string UserNameString = "bmackey"

Kode di atas seharusnya tidak memerlukan string kata kunci ditambahkan ke nama variabel. Jika Anda perlu mengidentifikasi jenis berdasarkan nama variabel, kode Anda terlalu panjang. Kondensasi-refactor.

Secara pribadi, saya pikir ini adalah opsi yang sangat valid untuk gaya kode Anda.

Itu adalah kata-kata yang dicadangkan sehingga kompiler tidak harus memutuskan apakah yang Anda maksud adalah mekanik bahasa atau variabel Anda. Dengan mengingat hal itu, itu menyiratkan bahwa mereka mengharapkan orang memiliki kebutuhan untuk variabel seperti kata yang dipesan.

Akan melalui sumber yang dibundel dengan JDK 1.6 R21, saya menemukan 917 kemunculan "clazz". Ternyata, mereka menganggap itu gaya yang bisa diterima.

Bagaimana perasaan tim Anda tentang hal itu? Jika Anda berpikir itu buruk, tetapi 9 orang lain di tim Anda berpikir itu baik, maka Anda harus menggigit peluru dan menerimanya. Selama ada komunikasi tentang apa yang baik dan apa yang tidak, dan Anda membawa masalah yang Anda lihat seperti yang Anda lihat, itu akan baik-baik saja.

Bagaimana tim Anda merasa tentang gaya kode lebih penting daripada pendapat saya, atau orang lain di posting ini . Itu berlaku untuk ini dan keputusan gaya kode lainnya yang mungkin Anda miliki.

Salah eja yang disengaja untuk menghindari kata-kata yang dipesan adalah ide yang buruk.

• Salah ejaan sulit dibedakan dari ejaan yang benar, karena itu membuat kode lebih sulit dibaca.

• Kesalahan mengeja sulit untuk diingat, sehingga beberapa kesalahan ejaan yang tidak konsisten cenderung bersaing dalam kode, yang membuat kode lebih sulit untuk ditulis dan lebih sulit untuk dibaca.

• Kata-kata yang dicadangkan mengacu pada bahasa yang digunakan untuk memecahkan masalah, bukan masalah itu sendiri. Nama variabel harus menunjuk ke konsep yang terkait dengan masalah.

Oleh karena itu lebih baik untuk memilih alternatif, nama deskriptif, atau jika tidak ada alternatif yang memuaskan, untuk memenuhi syarat kata yang dipesan seperti pada:

public static Method findBenchmarkMethod(BenchmarkRecord benchmark) {
    Class<?> benchmarkedClass = ClassUtils.loadClass(benchmark.generatedClass());
    return findBenchmarkMethod(benchmarkedClass, benchmark.generatedMethod());
}

Class clazzbaunya seperti "Saya tidak repot-repot mencoba datang dengan nama baik". Suatu variabel selalu mewakili sesuatu, dan nama yang baik menggambarkan hal itu. Saya menolak membayangkan bahwa clazzmisalnya dalam keadaan apa pun adalah nama terbaik. Apakah itu referensi ke kelas -> class_reference, adalah salinan objek kelas -> class_copy, dll. Mungkin juga menjatuhkan "class" dan hanya menggunakan kata deskriptif, misalnya

java.lang.SecurityManager.checkMemberAccess(Class<?> clazz, int which)
Parameters
    clazz -- the class that reflection is to be performed on.

Di sini clazz adalah kelas target tempat pemeriksaan dilakukan, jadi

checkMemberAccess(Class<?> target, int which)

akan lebih baik menggambarkan parameter apa yang digunakan untuk daripada yang akan pernah dilakukan clazz.

Jika mereka menggunakan nama yang dicadangkan untuk suatu variabel, itu adalah variabel dengan nama buruk. Bahkan jika itu adalah nama yang sah, seperti perangkat lunak Kelas untuk kelas.

Variabel yang namanya buruk adalah tanda kode yang dipikirkan dengan buruk atau kode biasa - berhati-hatilah terhadap gotcha lain dalam Bagian Perangkat Lunak yang Anda pelihara.

Saya pikir salah eja atau singkatan yang disengaja adalah ide yang baik jika digunakan dengan hati-hati dan konsisten .

Pertimbangkan di Jawa:

class X { public X() { } }
X x = new X();
x.getClass;  // Wha?  How does "get" help anything?
x.class;     // Best, but requires more lexer/parser work
x.klass;     // At least as good as getClass
x.clazz;     // Same

Tempat untuk menggunakan salah eja adalah tempat kata yang dicadangkan jelas merupakan kata terbaik untuk pekerjaan itu. Ada dua tempat untuk tidak menggunakan salah eja di mana Anda mungkin tergoda.

1. Anda tidak ingin memikirkan nama baik
2. Anda hanya ingin variabel dummy dan tidak perlu nama deskriptif

Dalam kasus pertama, cukup jelas bahwa kemalasan jarang merupakan kebijakan yang baik untuk membuat kode kualitas. Dalam kasus kedua, pilih variabel yang sangat pendek. Itulah yang dilakukan ahli matematika sepanjang waktu, dan programmer melakukan untuk indeks. Tidak ada alasan untuk membatasi diri Anda melakukan ini untuk indeks jika itu hanya variabel dummy:

boolean isMyName(String testName) { return myName.equals(testName); }
boolean isMyName(String s) { return myName.equals(s); }

Date nextMeeting(Klass klass) { return /* something */ }
Date nextMeeting(Klass k) { return /* something */ }

Anda tidak kehilangan apa pun dengan nama variabel pendek ketika metode atau struktur kode memberi tahu Anda apa yang harus ada di sana.

Saya telah melihat kegunaan yang sah Class klassketika melakukan refleksi di mana Anda benar-benar bekerja dengan instance Classkelas.

Saya sering melihat kode yang menyertakan kesalahan ejaan kata-kata umum yang disengaja menjadi lebih baik atau lebih buruk:

klass atau clazz untuk kelas: Class clazz = ThisClass.class

kount untuk hitung dalam SQL: count (*) AS kount

Secara pribadi saya menemukan ini mengurangi keterbacaan. Dalam praktik saya sendiri, saya belum menemukan terlalu banyak kasus di mana nama yang lebih baik tidak dapat digunakan - itemClass atau recordTotal.

Namun, itu sangat umum sehingga saya tidak bisa tidak bertanya-tanya apakah saya satu-satunya? Adakah yang punya saran atau bahkan lebih baik, rekomendasi yang dikutip dari programer yang dihormati tentang praktik ini?

Untuk variabel lokal dan argumen formal, itu tidak masalah.

Nama apa pun boleh saja asalkan tidak sengaja menyesatkan atau mengganggu. Dalam contoh Anda:

public static Method findBenchmarkMethod(BenchmarkRecord benchmark) {
    Class<?> clazz = ClassUtils.loadClass(benchmark.generatedClass());
    return findBenchmarkMethod(clazz, benchmark.generatedMethod());
}

tidak masalah apakah variabel lokal tunggal adalah "clazz" atau "klass" atau "cls" atau hanya "c". Saya mungkin hanya akan menyejajarkan ungkapan:

return findBenchmarkMethod(ClassUtils.loadClass(benchmark.generatedClass()),
                           benchmark.generatedMethod());

Panjang nama variabel harus terkait dengan ruang lingkup variabel. Untuk variabel lokal dalam metode pendek (dan semuanya harus pendek), nama yang sangat pendek baik-baik saja.

Saya pikir salah eja selalu merupakan ide yang buruk. Itu tidak baik pada pembaca Anda. Saya, misalnya, akan bertanya-tanya apakah saya melewatkan sesuatu ketika saya melihat kata itu klass. (Apakah yang mereka maksudkan class, atau apakah yang mereka maksudkan adalah bajak laut?) Setidaknya bagi saya, semua salah eja yang saya kenal menjengkelkan.

Untuk beberapa kasus, di mana kata yang dipesan benar-benar satu-satunya hal penting yang diketahui tentang variabel, saya akan menggunakan alternatif berikut:

• Jika itu argumen fungsi, gunakan aClasssebagai ganti class.

• Jika itu variabel lokal atau anggota, gunakan myClasssebagai ganti class.

• Jika itu accessor, gunakan getClass()sebagai ganti class().

Tentu saja, awalan yang ditambahkan tidak ada gunanya, dan akibatnya hanya akan digunakan sebagai upaya terakhir. Tapi setidaknya itu tidak mengganggu pengurai mental pembaca Anda, dan itu adalah cara yang gagal untuk menghindari kata-kata yang dicadangkan.

Satu manfaat untuk pengejaan kreatif, adalah kemampuan pencarian yang lebih baik. Saya pikir jauh lebih mudah untuk melakukan pencarian kode lengkap untuk hal-hal unik, daripada kata-kata umum, di mana terlalu sering Anda akan menemukan semua hal yang salah, dan 1000 di antaranya. Sebagai contoh, saya dulu memiliki kzpg.com. Google yang sekarang dan Anda akan melihat hanya beberapa hit. Ini unik dan karenanya sangat mudah ditemukan.

Tetapi untuk ukuran saya pikir pertanyaan ini adalah salah satu pendapat lebih dari substansi. Saya pribadi tumbuh di Forth di mana itu semua tentang kata-kata, dan banyak dari mereka. Seseorang belajar menjadi sangat kreatif untuk menyelamatkan jari-jarinya. Pada akhirnya saya memiliki sekitar 640.000 karakter, lebih atau kurang di basis sumber saya. Jadi, menjaga kata-kata pendek penting untuk menyelesaikan pekerjaan.