Eine zu komplizierte Benennung führt zu Chaos
TL;DR: Benennen ist schwierig, machen Sie es nicht durch unnötige versehentliche Komplexität schwieriger.
Unklare, irreführende, vage und mehrdeutige Namen
Redundante Terminologie
Verwirrende Abstraktionen
Kryptische Abkürzungen
Namenskonventionen vereinfachen
Konsistenz sicherstellen
Vermeiden Sie unnötigen Jargon
Verwenden Sie beschreibende Namen basierend auf dem Verhalten
Behalten Sie eine einheitliche Terminologie bei
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 sich andere nur schwer zurechtfinden.
Dies verursacht Fehler, erschwert die Wartung und führt zu Frustration im Team.
public class AbstractDataHandlerManager {
private String dtStr;
public void execProcessingOps(String input) {
if (dtStr != null && !dtStr.isEmpty()) {
// process
}
}
}
public class SETIProcessor {
public void processSignal(String input) {
// process
}
}
}
[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.
[X] Anfänger
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-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.
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.
Wittgensteins Konzept der sprachlichen Verwirrung
Code Smells sind meine Meinung.
Foto von Mimi Thian auf Unsplash
Der größte Feind einer klaren Sprache ist Unaufrichtigkeit.
George Orwell
Dieser Artikel ist Teil der CodeSmell-Reihe.
Das obige ist der detaillierte Inhalt vonCode-Geruch – sprachliche Verwirrung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!
![[Web-Frontend] Node.js-Schnellstart](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
