Bau Kod - Nama Fungsi Bukan Imperatif

Jadilah 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
• Beban kognitif yang meningkat
• 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. Sediakan konteks yang bermakna
6. Nyatakan tanggungjawab tunggal dengan jelas
7. Padankan tindakan dengan hasil

Pemfaktoran semula

Refactoring 005 - Gantikan Komen dengan Nama Fungsi

Maxi Contieri ・ 7 Jun '22

#javascript #pemula #refactorit #pengaturcaraan

Konteks

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

Ini membuang masa dan meningkatkan kemungkinan ralat.

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

Isu ini secara langsung berkaitan dengan prinsip Tell, Don’t Ask.

Daripada mendedahkan gelagat samar-samar yang memaksa pemanggil 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, proses, muat, 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 harus mencipta surat-menyurat satu sama satu yang jelas antara nama dan fungsinya.

Memecahkan 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 yang tidak jelas 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 melanggar kontrak ini dan membawa kepada kekeliruan.

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

perhubungan

Bau Kod 33 - Singkatan

Maxi Contieri ・ 24 Nov '20

#oop #codenewbie #pengaturcaraan #tutorial

Bau Kod 153 - Nama Terlalu Panjang

Maxi Contieri ・ 29 Jul '22

#javascript #webdev #pemula #pengaturcaraan

Bau Kod 38 - Nama Abstrak

Maxi Contieri ・ 30 Nov '20

#oop #codenewbie #menamakan #webdev

Bau Kod 174 - Nama Kelas dalam Atribut

Maxi Contieri ・ 29 Okt '22

#javascript #webdev #pemula #pengaturcaraan

Lihat juga

Apakah sebenarnya nama itu? — Bahagian I: Pencarian

Maxi Contieri ・ 9 Feb '21

#codenewbie #tutorial #webdev #oop

Apakah sebenarnya nama - Bahagian II Rehab

Maxi Contieri ・ 23 Mei '21

#tutorial #codenewbie #pengaturcaraan #webdev

Penafian

Bau Kod adalah pendapat saya.

Kredit

Foto oleh britishlibrary di Unsplash

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

Robert C. Martin

Petikan Hebat Kejuruteraan Perisian

Maxi Contieri ・ 28 Dis '20

#codenewbie #pengaturcaraan #quotes #perisian

Artikel ini adalah sebahagian daripada Siri CodeSmell.

Cara Mencari Bahagian Busuk Kod anda

Maxi Contieri ・ 21 Mei '21

#codenewbie #tutorial #codequality #pemula

Atas ialah kandungan terperinci Bau Kod - Nama Fungsi Bukan Imperatif. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!