Jeder Entwickler hat sich ihm vorgestellt: Dirty Code - Die Art von Code, die so aussieht, als wäre er in Eile geschrieben, mit magischen Nummern, doppelten Blöcken und kryptischen Variablennamen bestreut. Es funktioniert ... kaum. Aber es beibehalten? Das ist ein Albtraum.

Wenn Sie jemals in Ihrem Atem gemurmelt haben, während Sie den Code eines anderen anderen (oder sogar Ihren eigenen) neu gestaltet haben, ist dieser Artikel genau das Richtige für Sie. Hier sind einige einfache Regeln, um Ihren Code sauber, lesbar und zukunftssicher zu halten.

Was ist schmutziger Code?
Dirty Code ist Code, dass:

• ist schwer zu lesen oder zu verstehen.
• fehlt Struktur und Konsistenz.
• ist schwer zu ändern oder zu debuggen, ohne etwas anderes zu brechen.

Dies geschieht oft, wenn Entwickler:

1. Arbeit unter engen Fristen.
2. code rezensionen überspringen.
3. Befolgen Sie keine Best Practices oder Standards.

Warum ist Dirty ein Problem?

• Schwer zu debuggen: Behebung eines Fehlers kann fünf andere einführen.
• teuer zu pflegen: schlecht geschriebener Code dauert länger, um sich zu verbessern.
• Team Verwirrung: Neue Entwickler verbringen zusätzliche Stunden damit, nur zu verstehen, was passiert. Dirty Code kann den Job heute erledigen, aber es ist eine tickende Zeitbombe für Ihr Team und Ihr zukünftiges Selbst.

einfache Regeln, um schmutzigen Code zu vermeiden

1. Befolgen Sie das Prinzip der einzigen Verantwortung (SRP)
Jede Funktion, Methode oder Klasse sollte nur eine Sache tun. Wenn Sie Methoden mit zu vielen Verantwortlichkeiten schreiben, zerlegen Sie sie in kleinere Einheiten.

❌ schlechtes Beispiel:

def process_user_data(user):
    user['age'] = user['age']   1  
    db.save(user)  
    print(f"User {user['name']} updated")  

✅ Gutes Beispiel:

def update_user_age(user):
    user['age']  = 1  

def save_user_to_db(user):
    db.save(user)  

def log_user_update(user):
    print(f"User {user['name']} updated")  

Jede Funktion hat jetzt einen klaren Job, der den Code leichter zu testen und zu ändern.

2. Vermeiden Sie magische Zahlen und Zeichenfolgen
Hartcodierte Werte („magische Zahlen“) machen Code unlesbar und schwer zu warten. Verwenden Sie stattdessen Konstanten.

❌ schlechtes Beispiel:

if (statusCode === 404) {  
    console.log("Not Found");  
}

✅ Gutes Beispiel:

const NOT_FOUND = 404;

if (statusCode === NOT_FOUND) {  
    console.log("Not Found");  
}

Die konstante Not_found ist selbsterklärend und erleichtert Ihren Code leichter zu lesen.

3. Schreiben Sie beschreibende Variable und Funktionsnamen
Ihre Variablennamen sollten widerspiegeln, was sie darstellen. Vermeiden Sie Abkürzungen und kryptische Namen.

❌ schlechtes Beispiel:

int a = 5;  
String s = "John";  

✅ Gutes Beispiel:

int userAge = 5;  
String userName = "John";  

Das Gleiche gilt für Funktionen. Vermeiden Sie vage Namen wie dostuff () oder process (). Sei spezifisch.

4. Trocken (wiederhole dich nicht)
Wenn Sie Code kopieren und einfügen, machen Sie es falsch. Duplizierter Code macht Fehler, der einen Albtraum fixiert. Abstrakte sich wiederholende Logik in Funktionen oder Klassen.

❌ schlechtes Beispiel:

print("Welcome, John")  
print("Welcome, Mary")  

✅ Gutes Beispiel:

def greet_user(name):
    print(f"Welcome, {name}")  

greet_user("John")  
greet_user("Mary")  

5. Halten Sie Ihre Funktionen kurz
Wenn Ihre Funktion länger als 20-30 Zeilen ist, tut sie zu viel. Brechen Sie es in kleinere, wiederverwendbare Funktionen auf.

Lange Funktionen machen es schwieriger, ein bestimmtes Verhalten zu verstehen und zu testen.

6. Verwenden Sie Kommentare sparsam
Schreiben Sie Code, der sich selbst erklärt. Verwenden Sie Kommentare nur bei Bedarf, um die komplexe Logik zu klären. Vermeiden Sie Kommentare, die das Offensichtliche angeben.

❌ schlechtes Beispiel:

// Increment the counter by 1  
counter = counter   1;  

✅ Gutes Beispiel:
Wenn Ihr Code klar ist, ist kein Kommentar erforderlich:

counter  = 1;  

Verwenden Sie Kommentare für Dinge wie klar, warum eine bestimmte Entscheidung getroffen wurde, nicht was der Code tut.

7. Formatieren und organisieren Sie Ihren Code

• Folgen Sie einem konsistenten Codierungsstil -Handbuch (z. B. Pep8 für Python, Eslint für JavaScript).
.
• Verwenden Sie die richtige Einklebung.
• Gruppenbezogener Code miteinander. Gute Formatierung macht Code ohne zusätzliche Anstrengung sauber und lesbar.

Die Denkweise des Entwicklers: Code für Menschen schreiben
Code wird nicht nur für Maschinen geschrieben. Es ist auch für Menschen geschrieben - Ihre Teamkollegen, zukünftigen Betreuer oder sogar selbst in sechs Monaten. Wenn Sie sauberen Code schreiben:

• Sie reduzieren mentale Ladung für andere.
• Sie machen es einfacher, zu debuggen, zu erweitern und zu verbessern.
• Sie sehen aus wie ein professioneller Entwickler, der Qualität schätzt.

endgültige Gedanken
Das Vermeiden von schmutzigem Code ist nicht schwer - es erfordert nur Disziplin. Befolgen Sie diese einfachen Regeln:

1. halten Sie sich an das Prinzip der einzigen Verantwortung.
2. Vermeiden Sie magische Zahlen.
3. Verwenden Sie klare, beschreibende Namen.
4. austrocknen sich wiederholter Code.
5. Funktionen kurz.
6. Verwenden Sie Kommentare mit Bedacht.
7. formatiere deinen Code konsequent.

In Clean Code geht es nicht um Perfektion. Es geht darum, Ihre Arbeit aufrechterhalten und verständlich zu machen. Ihr zukünftiges Selbst - und Ihr Team - wird sich danke.

Jetzt gehen Sie und refaktieren Sie diesen unordentlichen Code, den Sie ignoriert haben! ?