Eine zu komplizierte Benennung führt zu Chaos

TL;DR: Benennen ist schwer, machen Sie es nicht durch unnötige versehentliche Komplexität noch schwieriger.

Probleme

• Unklare, irreführende, vage und mehrdeutige Namen

• Redundante Terminologie

• Verwirrende Abstraktionen

• Kryptische Abkürzungen

Lösungen

1. Namenskonventionen vereinfachen

2. Konsistenz sicherstellen

3. Vermeiden Sie unnötigen Jargon

4. Verwenden Sie beschreibende Namen basierend auf dem Verhalten

5. Konsistente Terminologie beibehalten

Kontext

Ludwig Wittgenstein argumentierte, dass viel Verwirrung durch Sprachmissbrauch entsteht.

Das passiert, wenn Sie Namen zu kompliziert machen, Metaphern vermischen oder inkonsistente Terminologie verwenden.

Wenn Sie Klassen, Methoden oder Variablen unverständlich benennen, schaffen Sie ein sprachliches Labyrinth, in dem andere nur schwer navigieren können.

Dies verursacht Fehler, erschwert die Wartung und führt zu Frustration im Team.

Beispielcode

Falsch

public class AbstractDataHandlerManager {
    private String dtStr;

    public void execProcessingOps(String input) {
        if (dtStr != null && !dtStr.isEmpty()) {
            // process
        }
    }
}

Rechts

public class SETIProcessor {

    public void processSignal(String input) {      
            // process
        }
    }
}

Erkennung

[X] Handbuch

Sie können diesen Geruch erkennen, wenn Namen lang werden oder wenn Sie „Abstract“, „Manager“, „Handler“, „Helper“ oder „Data“ zu oft sehen.

Ein weiteres Zeichen ist, wenn Sie anderen Entwicklern erklären müssen, was ein Name bedeutet, beispielsweise bei einer Codeüberprüfung.

Schlagworte

• Benennung

Ebene

[X] Anfänger

KI-Generierung

KI-Generatoren erzeugen diesen Geruch oft, indem sie ausführliche und generische Namen erzeugen, die versuchen, jeden möglichen Kontext abzudecken.

Sie sind Experten in vielen Bereichen und schreiben Code, aber oft tun sie nicht beides gleichzeitig, es sei denn, sie werden dazu angewiesen.

KI-Erkennung

KI-Generatoren können diesen Geruch manchmal mit einfachen Refactoring-Anweisungen wie „Namen vereinfachen“ oder „überflüssige Begriffe entfernen“ beheben, haben jedoch Schwierigkeiten mit einem tieferen Kontextverständnis.

Abschluss

Sprachliche Verwirrung im Code führt zu unnötiger Komplexität.

Verwenden Sie eine klare, konsistente und unkomplizierte Benennung, um die Lesbarkeit und Wartung Ihres Codes zu erleichtern.

Beziehungen

Code Smell 22 – Helfer

Maxi Contieri ・ 12. November 2020

#oop #Helfer #codenewbie #Anfänger

Code Smell 38 – Abstrakte Namen

Maxi Contieri ・ 30. Nov. '20

#oop #codenewbie #Benennung #webdev

Code Smell 197 – Unentgeltlicher Kontext

Maxi Contieri ・ 21. Februar 2023

#webdev #Anfänger #Programmierung #tutorial

Code Smell 113 – Datenbenennung

Maxi Contieri ・ 5. Jan. '22

#oop #webdev #Datenbank #Refactoring

Weitere Informationen

Wittgensteins Konzept der sprachlichen Verwirrung

Was ist (falsch mit) Software?

Maxi Contieri ・ 8. Okt. '20

#oop #solide #Anfänger #Design

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 Mimi Thian auf Unsplash

Der größte Feind einer klaren Sprache ist Unaufrichtigkeit.

George Orwell

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