Jadi Imperatif!!

TL;DR: Fungsi dengan nama yang tidak jelas menyembunyikan niat dan mengelirukan pembaca. Gunakan nama deskriptif, berorientasikan tindakan.

Masalah

• Tujuan fungsi yang tidak jelas
• Peningkatan beban kognitif
• Konteks yang mengelirukan
• Kebolehbacaan berkurangan
• Kerjasama yang sukar
• Fungsi tersembunyi

Penyelesaian

1. Gunakan kata kerja berorientasikan tindakan
2. Jadikan nama sebagai deskriptif
3. Mencerminkan tujuan fungsi
4. Elakkan istilah generik
5. Menyediakan konteks yang bermakna
6. Nyatakan tanggungjawab tunggal dengan jelas
7. Padankan tindakan dengan hasil

Pemfaktoran semula

https://hackernoon.com/improving-the-code-one-line-at-a-time

Konteks

Fungsi yang dinamakan dengan istilah generik memaksa pembaca untuk menyelami pelaksanaan untuk memahami tingkah laku mereka.

Ini membuang masa dan meningkatkan peluang kesilapan.

Penamaan menjadi lebih kritikal apabila bekerja dengan fungsi kendiri, di mana nama kelas tidak memberikan konteks tambahan.

Isu ini secara langsung berkaitan dengan prinsip Beritahu, Jangan Tanya .

Daripada mendedahkan tingkah laku samar-samar yang memaksa pemanggil untuk membuat kesimpulan kefungsian, nama penting menyampaikan tindakan yang tepat, membimbing pembaca tanpa perlu memeriksa kod.

Apabila anda menamakan fungsi secara deskriptif, anda menghapuskan tekaan yang tidak perlu dan selaras dengan prinsip ini.

Kod Contoh

salah

 public String dateFormatting(Date date) { return new SimpleDateFormat("yyyy-MM-dd").format(date); } public void load() { System.out.println("Loading..."); }

Betul

 public String formatDate(Date date) { return new SimpleDateFormat("yyyy-MM-dd").format(date); } public void loadUserPreferences() { System.out.println("Loading user preferences..."); }

Pengesanan

• [x] Manual

Anda boleh mengesan bau ini dengan menyemak nama fungsi yang menggunakan istilah yang tidak jelas seperti do , run , process , load , dsb.

Linter automatik boleh membenderakan corak ini atau menyerlahkan fungsi dengan nama yang terlalu generik.

Tag

• Penamaan

Tahap

• [x] Pemula

Mengapa Bijection Itu Penting

Nama fungsi hendaklah mencipta surat-menyurat satu dengan satu yang jelas antara nama dan fungsinya.

Pemecahan Bijection ini memaksa pembangun untuk memeriksa butiran kod untuk konteks, memperlahankan penyahpepijatan, ulasan dan sambungan.

Penjanaan AI

Alat AI kadangkala menjana nama fungsi generik tanpa memahami domain anda.

Apabila menggunakan AI, nyatakan bahawa nama fungsi mestilah deskriptif dan berorientasikan tindakan.

Pengesanan AI

Model AI boleh membantu mengesan nama samar-samar dengan membandingkan tandatangan fungsi dengan amalan terbaik penamaan yang telah ditetapkan.

Menggabungkan AI dengan semakan kod manual menghasilkan hasil yang terbaik.

Cuba Mereka!

Ingat: AI Assistants melakukan banyak kesilapan

Kesimpulan

Nama fungsi bukan sekadar label; mereka adalah kontrak dengan pembaca.

Nama yang samar-samar memecahkan kontrak ini dan membawa kepada kekeliruan.

Nama deskriptif, berorientasikan tindakan memudahkan komunikasi dan menjadikan kod anda lebih mudah untuk dikekalkan dan dilanjutkan.

perhubungan

Lihat juga

Penafian

Bau Kod adalah pendapat saya.

Kredit

Foto oleh britishlibrary di Unsplash

Nama fungsi mestilah kata kerja atau frasa kata kerja, dan ia perlu bermakna

Robert C. Martin

Artikel ini adalah sebahagian daripada Siri CodeSmell.