Code-Geruch – Namen nicht zwingender Funktionen

Seien Sie zwingend!!

TL;DR: Funktionen mit unklaren Namen verbergen die Absicht und verwirren die Leser. Verwenden Sie beschreibende, handlungsorientierte Namen.

Probleme

• Unklarer Funktionszweck
• Erhöhte kognitive Belastung
• Irrführender Kontext
• Eingeschränkte Lesbarkeit
• Schwierige Zusammenarbeit
• Versteckte Funktionalität

Lösungen

1. Verwenden Sie handlungsorientierte Verben
2. Machen Sie Namen aussagekräftig
3. Den Zweck der Funktion widerspiegeln
4. Vermeiden Sie generische Begriffe
5. Stellen Sie einen aussagekräftigen Kontext bereit
6. Einzelverantwortung klar zum Ausdruck bringen
7. Aktion dem Ergebnis zuordnen

Refactorings

Refactoring 005 – Kommentar durch Funktionsnamen ersetzen

Maxi Contieri ・ 7. Juni 22

#javascript #Anfänger #refactorit #Programmierung

Kontext

Mit generischen Begriffen benannte Funktionen zwingen den Leser, in die Implementierung einzutauchen, um ihr Verhalten zu verstehen.

Das verschwendet Zeit und erhöht die Fehlerwahrscheinlichkeit.

Die Benennung wird noch wichtiger, wenn Sie mit eigenständigen Funktionen arbeiten, bei denen der Klassenname keinen zusätzlichen Kontext bietet.

Dieses Problem steht in direktem Zusammenhang mit dem Tell, Don't Ask-Prinzip.

Anstatt mehrdeutiges Verhalten aufzudecken, das den Aufrufer dazu zwingt, auf die Funktionalität zu schließen, vermitteln imperative Namen die genaue Aktion und leiten den Leser an, ohne den Code untersuchen zu müssen.

Wenn Sie Funktionen beschreibend benennen, vermeiden Sie unnötiges Rätselraten und richten sich nach diesem Prinzip.

Beispielcode

Falsch

public String dateFormatting(Date date) {
    return new SimpleDateFormat("yyyy-MM-dd").format(date);
}

public void load() {
    System.out.println("Loading...");
}

Rechts

public String formatDate(Date date) {
    return new SimpleDateFormat("yyyy-MM-dd").format(date);
}

public void loadUserPreferences() {
    System.out.println("Loading user preferences...");
}

Erkennung

[X] Handbuch

Sie können diesen Geruch erkennen, indem Sie Funktionsnamen überprüfen, die vage Begriffe wie do, run, process, load usw. enthalten .

Automatisierte Linters können diese Muster kennzeichnen oder Funktionen mit übermäßig generischen Namen hervorheben.

Schlagworte

• Benennung

Ebene

[X] Anfänger

Warum die Bijektion wichtig ist

Funktionsnamen sollten eine klare Eins-zu-eins-Entsprechung zwischen ihrem Namen und ihrer Funktionalität herstellen.

Das Durchbrechen dieser Bijektion zwingt Entwickler dazu, Codedetails auf Kontext zu untersuchen, was Debugging, Überprüfungen und Erweiterungen verlangsamt.

KI-Generierung

KI-Tools generieren manchmal generische Funktionsnamen, ohne Ihre Domäne zu verstehen.

Geben Sie bei der Verwendung von KI an, dass Funktionsnamen beschreibend und handlungsorientiert sein müssen.

KI-Erkennung

KI-Modelle können dabei helfen, mehrdeutige Namen zu erkennen, indem sie Funktionssignaturen mit vordefinierten Best Practices für die Benennung vergleichen.

Die Kombination von KI mit manueller Codeüberprüfung liefert die besten Ergebnisse.

Probieren Sie sie aus!

Denken Sie daran: KI-Assistenten machen viele Fehler

Abschluss

Funktionsnamen sind nicht nur Bezeichnungen; es handelt sich um Verträge mit dem Leser.

Mehrdeutige Namen brechen diesen Vertrag und führen zu Verwirrung.

Beschreibende, handlungsorientierte Namen vereinfachen die Kommunikation und erleichtern die Wartung und Erweiterung Ihres Codes.

Beziehungen

Code Smell 33 – Abkürzungen

Maxi Contieri ・ 24. November 2020

#oop #codenewbie #Programmierung #tutorial

Code Smell 153 – Zu lange Namen

Maxi Contieri ・ 29.07.22

#javascript #webdev #Anfänger #Programmierung

Code Smell 38 – Abstrakte Namen

Maxi Contieri ・ 30. November 2020

#oop #codenewbie #Benennung #webdev

Code Smell 174 – Klassenname in Attributen

Maxi Contieri ・ 29. Okt. 22

#javascript #webdev #Anfänger #Programmierung

Siehe auch

Was genau ist ein Name? — Teil I: Die Suche

Maxi Contieri ・ 9. Februar 21

#codenewbie #tutorial #webdev #oop

Was genau ist ein Name – Teil II Reha

Maxi Contieri ・ 23. Mai 21

#tutorial #codenewbie #Programmierung #webdev

Haftungsausschluss

Code Smells sind meine Meinung.

Credits

Foto von britishlibrary auf Unsplash

Ein Funktionsname sollte ein Verb oder eine Verbphrase sein und muss es auch sein
sinnvoll

Robert C. Martin

Tolle Software-Engineering-Zitate

Maxi Contieri ・ 28. Dezember 2020

#codenewbie #Programmierung #Zitate #Software

Dieser Artikel ist Teil der CodeSmell-Reihe.

So finden Sie die stinkenden Teile Ihres Codes

Maxi Contieri ・ 21. Mai '21

#codenewbie #tutorial #codequalität #Anfänger

Das obige ist der detaillierte Inhalt vonCode-Geruch – Namen nicht zwingender Funktionen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!