Légy kötelező!!  TL;DR: A nem egyértelmű nevű funkciók elrejtik a szándékot és összezavarják az olvasókat. Használjon leíró, cselekvésorientált neveket.  Problémák  Nem egyértelmű a funkció célja  Fokozott kognitív terhelés  Félrevezető kontextus  Csökkentett olvashatóság  Nehéz együttműködés  Rejtett funkciók  Megoldások  Használj cselekvés-orientált igéket  Tedd   jellegűvé a neveket leíró  Tükrözze a funkció célját  Kerülje az általános kifejezéseket  Adjon értelmes kontextust  Világosan fejezze ki az egyetlen felelősséget  Párosítsa a cselekvést az eredménnyel  Refaktorálások   https://hackernoon.com/improving-the-code-one-line-at-a-time  Kontextus  Az általános kifejezésekkel elnevezett függvények arra kényszerítik az olvasókat, hogy belemerüljenek a megvalósításba, hogy megértsék viselkedésüket.  Ez időt veszít, és növeli a hibák esélyét.    még kritikusabbá válik, ha önálló függvényekkel dolgozik, ahol az osztálynév nem biztosít további kontextust. A névadás  Ez a probléma közvetlenül kapcsolódik a   . Mondd, ne kérdezz elvhez  Ahelyett, hogy olyan kétértelmű viselkedéseket tárnának fel, amelyek arra kényszerítik a hívót, hogy funkcionalitásra következtessen, a kötelező nevek a pontos műveletet közvetítik, és a kód ellenőrzése nélkül irányítják az olvasót.  Ha a függvényeket leíró jelleggel nevezi meg, kiküszöböli a felesleges találgatásokat, és igazodik ehhez az elvhez.  Minta kód  Rossz   public String dateFormatting(Date date) { return new SimpleDateFormat("yyyy-MM-dd").format(date); } public void load() { System.out.println("Loading..."); }  Jobbra   public String formatDate(Date date) { return new SimpleDateFormat("yyyy-MM-dd").format(date); } public void loadUserPreferences() { System.out.println("Loading user preferences..."); }  Érzékelés    Kézi [x]  Ezt a szagot úgy észlelheti, hogy áttekinti a függvényneveket, amelyek homályos kifejezéseket használnak, mint például   ,   ,   ,   stb. a do run process load  Az automatizált linterek megjelölhetik ezeket a mintákat, vagy kiemelhetik a funkciókat túlságosan általános nevekkel.  Címkék  Elnevezés  Szint    Kezdő [x]  Miért fontos a Bijection?  A függvényneveknek egyértelmű   kell létrehozniuk a nevük és a funkcióik között. egy az egyhez egyezést  A   megszakítása arra kényszeríti a fejlesztőket, hogy megvizsgálják a kódrészleteket a környezet szempontjából, lelassítva a hibakeresést, az áttekintéseket és a bővítményeket. Bijection  AI generáció  Az AI-eszközök néha generikus függvényneveket generálnak anélkül, hogy megértenék a domainjét.  AI használatakor adja meg, hogy a függvényneveknek leíró jellegűnek és cselekvés-orientáltnak kell lenniük.  AI észlelés  Az AI-modellek segíthetnek felismerni a kétértelmű neveket, ha összehasonlítják a függvényaláírásokat az előre meghatározott elnevezési bevált gyakorlatokkal.  A mesterséges intelligencia és a kézi kódellenőrzés kombinálása a legjobb eredményt nyújtja.  Próbáld ki őket!   Ne feledje: az AI-asszisztensek sok hibát követnek el  Megfelelő utasítások nélkül  Speciális utasításokkal   ChatGPT   ChatGPT   Claude   Claude   Zavar   Zavar   Másodpilóta   Másodpilóta   Ikrek   Ikrek  Következtetés  A függvénynevek nem csak címkék; ezek az olvasóval kötött szerződések.    megszegik ezt a szerződést, és zűrzavarhoz vezetnek. A kétértelmű nevek  A leíró, cselekvésorientált nevek leegyszerűsítik a kommunikációt, és megkönnyítik a kód karbantartását és bővítését.  Kapcsolatok   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-vii-8dk31x0?embedable=true https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxi?embedable=true   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-viii-8mn3352?embedable=true https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxv?embedable=true  Lásd még   https://hackernoon.com/what-exactly-is-a-name-the-quest-part-i-fmw3udc?embedable=true   https://hackernoon.com/what-exactly-is-a-name-rehab-part-ii-4st3uph?embedable=true  Jogi nyilatkozat  Code Smells az én   . véleményem  Kredit  Fotó:     oldalon britishlibrary az Unsplash  A függvénynév ige vagy igei kifejezés lehet, és értelmesnek kell lennie   Robert C. Martin   https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true  Ez a cikk a CodeSmell sorozat része.   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-i-xqz3evd?embedable=true

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

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

Code Smell 285 – A nem kötelező funkciók javítása

About Author

HOZZÁSZÓLÁSOK

HANG TAGOK

EZT A CIKKET BEMUTATTA

Related Stories

HackerNoon Raises $250k at $50M Valuation From Forward Research

The Little Shop at Fishbourne

From Desk to HackerNoon: Your Ultimate Guide on How to Publish a Story

HackerNoon Contributor Denisa Ganea on HackerNoon, Human Existence, and Everything in Between

HackerNoon Raises $250k at $50M Valuation From Forward Research

The Little Shop at Fishbourne

From Desk to HackerNoon: Your Ultimate Guide on How to Publish a Story

HackerNoon Contributor Denisa Ganea on HackerNoon, Human Existence, and Everything in Between

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps