paint-brush
Kode Reuk 285 - Hoe om nie-noodsaaklike funksies reg te steldeur@mcsee
290 lesings

Kode Reuk 285 - Hoe om nie-noodsaaklike funksies reg te stel

deur 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
af-flagAF
Lees hierdie storie in Afrikaans!
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!
ms-flagMS
Baca cerita ini dalam bahasa Melayu!
th-flagTH
อ่านเรื่องนี้เป็นภาษาไทย!
AF

Te lank; Om te lees

Funksies met onduidelike name verberg bedoeling en verwar lesers. Gebruik beskrywende, aksie-georiënteerde name.
featured image - Kode Reuk 285 - Hoe om nie-noodsaaklike funksies reg te stel
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.

Wees noodsaaklik!!

TL;DR: Funksies met onduidelike name verberg bedoeling en verwar lesers. Gebruik beskrywende, aksie-georiënteerde name.

Probleme

  • Onduidelike funksie doel
  • Verhoogde kognitiewe lading
  • Misleidende konteks
  • Verminderde leesbaarheid
  • Moeilike samewerking
  • Versteekte funksionaliteit

Oplossings

  1. Gebruik aksie-georiënteerde werkwoorde
  2. Maak name beskrywend
  3. Gee die doel van die funksie weer
  4. Vermy generiese terme
  5. Verskaf betekenisvolle konteks
  6. Druk enkele verantwoordelikheid duidelik uit
  7. Pas aksie by uitkoms

Refaktorerings

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

Konteks

Funksies wat met generiese terme genoem word, dwing lesers om in die implementering te duik om hul gedrag te verstaan.


Dit mors tyd en verhoog die kans op foute.


Naamgewing word selfs meer krities wanneer daar met selfstandige funksies gewerk word, waar die klasnaam nie addisionele konteks verskaf nie.


Hierdie kwessie hou direk verband met die Vertel, moenie vra-beginsel nie .


In plaas daarvan om dubbelsinnige gedrag aan die kaak te stel wat die oproeper dwing om funksionaliteit af te lei, dra imperatiewe name die presiese aksie oor en lei die leser sonder om die kode te inspekteer.


Wanneer jy funksies beskrywend benoem, skakel jy onnodige raaiwerk uit en pas jy by hierdie beginsel aan.

Voorbeeld kode

Verkeerd

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

Reg

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

Opsporing

  • [x] Handleiding

Jy kan hierdie reuk opspoor deur funksiename te hersien wat vae terme soos doen , hardloop , verwerk , laai , ens.


Outomatiese linters kan hierdie patrone vlag of funksies met té generiese name uitlig.

Merkers

  • Naamgewing

Vlak

  • [x] Beginner

Waarom die Bijection belangrik is

Funksiename moet 'n duidelike een-tot-een ooreenstemming tussen hul naam en funksionaliteit skep.


Deur hierdie Bijection te breek, dwing ontwikkelaars om kodebesonderhede vir konteks te ondersoek, wat ontfouting, resensies en uitbreidings vertraag.

AI Generasie

KI-nutsgoed genereer soms generiese funksiename sonder om jou domein te verstaan.


Wanneer u KI gebruik, spesifiseer dat funksiename beskrywend en aksiegeoriënteerd moet wees.

KI-opsporing

KI-modelle kan help om dubbelsinnige name op te spoor deur funksie-handtekeninge te vergelyk met voorafbepaalde benaming-beste praktyke.


Die kombinasie van KI met handmatige kodehersiening lewer die beste resultate.

Probeer hulle!

Onthou: KI-assistente maak baie foute

Sonder behoorlike instruksies

Met spesifieke instruksies

ChatGPT

ChatGPT

Claude

Claude

Verwarring

Verwarring

Medevlieënier

Medevlieënier

Tweeling

Tweeling

Gevolgtrekking

Funksiename is nie net byskrifte nie; dit is kontrakte met die leser.


Dubbelsinnige name verbreek hierdie kontrak en lei tot verwarring.


Beskrywende, aksie-georiënteerde name vereenvoudig kommunikasie en maak jou kode makliker om te onderhou en uit te brei.

Verhoudings


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.)

Sien ook


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.

Disclaimer

Code Smells is my mening .

Krediete

Foto deur britishlibrary op Unsplash


'n Funksienaam moet 'n werkwoord of 'n werkwoordfrase wees, en dit moet betekenisvol wees

Robert C. Martin


article preview
HACKERNOON

400+ Thought-Provoking Software Engineering Quotes | HackerNoon

The most complete curated collection of software and programming quotes


Hierdie artikel is deel van die CodeSmell-reeks.


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

HANG TAGS

HIERDIE ARTIKEL IS AANGEBIED IN...

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