Code-Geruch – Hanlons Rasiermesser

Machen Sie es nicht zu kompliziert: Halten Sie es einfach

TL;DR: Übermäßiger Code führt zu unnötiger Komplexität.

Probleme

• Unnötige Komplexität

• Verwirrende Logik

• Versteckte Fehler

• Schwierigere Wartung

• Langsamere Leistung

• Überladener Code

Lösungen

1. Überprüfungen vereinfachen

2. Vertrauen Sie Ihrer Logik

3. Konzentrieren Sie sich auf das Wesentliche

4. Folgen Sie dem K.I.S.S. Prinzip

5. Regelmäßig umgestalten

Kontext

Übermäßiges Nachdenken und Überdesign Ihres Codes kann zu unnötiger Komplexität führen.

Möglicherweise müssen Sie sich gegen jedes mögliche Szenario verteidigen, aber dieser Ansatz führt oft zu aufgeblähtem, verwirrendem Code.

Hanlon's Razor legt nahe, dass Sie keine Bosheit annehmen sollten, wenn einfache Fehler oder Missverständnisse wahrscheinlicher sind.

Vermeiden Sie eine übermäßig defensive Programmierung und konzentrieren Sie sich auf eine klare, unkomplizierte Logik.

Sie könnten zukünftige Probleme vorhersehen, die möglicherweise nie auftreten, oder versuchen, Ihren Code zu flexibel zu gestalten.

Einfacher Code ist einfacher zu warten, zu debuggen und zu verstehen.

Beispielcode

Falsch

function processData(data) {
    if (typeof data === 'undefined') {
        throw new Error('Data is undefined');
    }

    if (typeof data !== 'object') {
        throw new Error('Data is not an object');
    }

    if (data === null) {
        throw new Error('Data is null');
    }

    if (Array.isArray(data)) {
        throw new Error('Data should not be an array');
    }

    if (!data.hasOwnProperty('items')) {
        return [];
    }

    if (!Array.isArray(data.items)) {
        throw new Error('Items should be an array');
    }

    if (data.items.length === 0) {
        return []; 
    }

    let processedItems = [];
    for (let item of data.items) {
        if (typeof item === 'undefined') {
            continue; // Skip undefined items
        }

        if (typeof item !== 'object') {
            continue; // Skip non-object items
        }

        if (item === null) {
            continue; // Skip null items
        }

        processedItems.push(processItem(item));
    }

    return processedItems;
}

Rechts

function processData(data) {
    if (!Array.isArray(data.items)) {
        throw new Error('Invalid data');
    }

    return data.items
        .filter(item => typeof item === 'object' && item !== null)
        .map(item => processItem(item));
}

Erkennung

[X] Handbuch

Komplizierter Code hat normalerweise mehr Zeilen und lange Methoden sind ein möglicher Hinweis.

Schlagworte

• Aufbläher

Ebene

[x] Mittelstufe

KI-Generierung

KI-Generatoren können diesen Geruch hervorrufen, wenn sie versuchen, jeden möglichen Randfall zu berücksichtigen.

Der Umgang mit NULL-Werten ist beispielsweise unnötig, wenn Sie sie vollständig vermeiden.

KI-Erkennung

KI-Tools können dabei helfen, übermäßig defensiven Code zu erkennen, indem sie die Logik analysieren und mit der richtigen Anleitung Vereinfachungen vorschlagen.

Diese Tools empfehlen oft, unnötige Prüfungen zu entfernen oder sie aus Gründen der Übersichtlichkeit zu kombinieren.

Abschluss

Vermeiden Sie übermäßiges Nachdenken und Übergestalten Ihres Codes.

Konzentrieren Sie sich auf die wahrscheinlichsten Szenarien und schreiben Sie eine klare, unkomplizierte Logik.

Einfachheit führt zu besserer Codequalität und einfacherer Wartung.

Beziehungen

Code Smell 149 – Optionale Verkettung

Maxi Contieri ・ 16. Juli '22

#javascript #webdev #Anfänger #Programmierung

Code Smell 12 – Null

Maxi Contieri ・ 31. Okt. '20

#codenewbie #tutorial #oop

Weitere Informationen

Wikipedia

Defensive Programmierung

Haftungsausschluss

Code Smells sind meine Meinung.

Credits

Foto von Nacho Fernández auf Unsplash

---

Einfachheit ist die ultimative Raffinesse.

Leonardo da Vinci

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 – Hanlons Rasiermesser. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!