paint-brush
Bau Kod 285 - Cara Membetulkan Fungsi Bukan Imperatifoleh@mcsee
290 bacaan

Bau Kod 285 - Cara Membetulkan Fungsi Bukan Imperatif

oleh Maximiliano Contieri
Maximiliano Contieri HackerNoon profile picture

Maximiliano Contieri

@mcsee

I’m a sr software engineer specialized in Clean Code, Design...

3 min read2025/01/11
Read on Terminal Reader
Read this story in a terminal
Print this story
tldt arrow
ms-flagMS
Baca cerita ini dalam bahasa Melayu!
en-flagEN
Read this story in the original language, English!
bn-flagBN
এই গল্পটি বাংলায় পড়ুন!
es-flagES
Lee esta historia en Español!
ja-flagJA
この物語を日本語で読んでください!
sr-flagSR
Прочитајте ову причу на српском!
sw-flagSW
Soma hadithi hii kwa kiswahili!
ka-flagKA
წაიკითხეთ ეს ამბავი ქართულად!
kk-flagKK
Бұл оқиғаны қазақша оқыңыз!
sq-flagSQ
Lexojeni këtë histori në shqip!
hu-flagHU
Olvasd el ezt a történetet magyarul!
af-flagAF
Lees hierdie storie in Afrikaans!
th-flagTH
อ่านเรื่องนี้เป็นภาษาไทย!
MS

Terlalu panjang; Untuk membaca

Fungsi dengan nama yang tidak jelas menyembunyikan niat dan mengelirukan pembaca. Gunakan nama deskriptif, berorientasikan tindakan.
featured image - Bau Kod 285 - Cara Membetulkan Fungsi Bukan Imperatif
Maximiliano Contieri HackerNoon profile picture
Maximiliano Contieri

Maximiliano Contieri

@mcsee

I’m a sr software engineer specialized in Clean Code, Design and TDD Book "Clean Code Cookbook" 500+ articles written

0-item

STORY’S CREDIBILITY

Original Reporting

Original Reporting

This story contains new, firsthand information uncovered by the writer.

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

Tanpa Arahan Yang Betul

Dengan Arahan Tertentu

SembangGPT

SembangGPT

Claude

Claude

Kebingungan

Kebingungan

Copilot

Copilot

Gemini

Gemini

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


article preview
HACKERNOON

How to Find The Stinky Parts of Your Code (Part VII) | HackerNoon

We see several symptoms and situations that make us doubt the quality of our development.


article preview
HACKERNOON

How to Find the Stinky Parts of Your Code [Part XXXI] | HackerNoon

Beginners are afraid to remove code. And many seniors too.


article preview
HACKERNOON

How to Find The Stinky Parts of Your Code (Part VIII) | HackerNoon

Yet more code smells? Plenty of!


article preview
HACKERNOON

How to Find the Stinky Parts of Your Code [Part XXXV] | HackerNoon

Most of these smells are just hints of something that might be wrong. Therefore, they are not required to be fixed per se… (You should look into it, though.)

Lihat juga


article preview
HACKERNOON

What Exactly Is A Name: The Quest [Part I] | HackerNoon

We all agree: a good name is always the most important thing. Let’s find them.


article preview
HACKERNOON

What Exactly Is A Name: Rehab [Part II] | HackerNoon

We all agree: a good name is always the most important thing. Let’s find them.

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


article preview
HACKERNOON

400+ Thought-Provoking Software Engineering Quotes | HackerNoon

The most complete curated collection of software and programming quotes


Artikel ini adalah sebahagian daripada Siri CodeSmell.


article preview
HACKERNOON

How to Find the Stinky Parts of Your Code (Part I) | HackerNoon

The code smells bad. Let’s see how to change the aromas. In this series, we will see several symptoms and situations that make us doubt the quality of our developments. We will present possible solutions. Most of these smells are just hints of something that might be wrong. They are not rigid rules.


L O A D I N G
. . . comments & more!

About Author

Maximiliano Contieri HackerNoon profile picture
Maximiliano Contieri@mcsee
I’m a sr software engineer specialized in Clean Code, Design and TDD Book "Clean Code Cookbook" 500+ articles written

GANTUNG TANDA

ARTIKEL INI DIBENTANGKAN DALAM...

Read on Terminal Reader
Read this story in a terminal
 Terminal
Read this story w/o Javascript
Read this story w/o Javascript
 Lite
X REMOVE AD