So schreiben Sie sauberen Code – Tipps für Entwickler mit Beispielen

Stellen Sie sich einen Raum vor, der so unordentlich ist, dass Sie Ihre Schlüssel nicht finden können. Überall Kleidung, Bücher gestapelt und Chaos herrscht.

Stellen Sie sich nun vor, Sie arbeiten mit unordentlichem Code.

Es ist die GLEICHE Katastrophe, außerjetzt ist es Ihr Gehirn, das seinen Verstand verliert.


Sauberer Code hingegen ist, als würde man einen makellosen Raum betreten. Alles ist genau dort, wo es sein soll. Kein Stress. Keine Verwirrung. Nur Klarheit.

Hier ist die Wahrheit: Das Schreiben von sauberem Code ist NICHT optional, wenn Sie in der Softwareentwicklung erfolgreich sein wollen.

Sie können chaotischen Code schreiben und die Person sein, die darum kämpft, jeden Fehler zu beheben oder Sie können sauberen Code beherrschen und jedes Projekt, das Sie berühren, DOMINIEREN.

---

Sauberer Programmierer vs. unordentlicher Programmierer

Lass mich dir ein Bild malen.

Hier ist eine Grafik, die die Reise von zwei Arten von Programmierern zeigt:

• ⚠️ Schlechter Programmierer (rote Linie): Startet schnell, stürzt aber stark ab. Je mehr Zeilen sie schreiben, desto mehr Ärger machen sie.
• ⚡ Clean Code (Blaue Linie): Startet langsam, bleibt aber konsistent. Das Wachstum hört nicht auf – es beschleunigt sich.

Jetzt entscheiden Sie, welcher Linie Sie folgen möchten.

Kosten für fehlerhaften Code

Um dieses Diagramm zu veranschaulichen: In der ersten Entwicklungsphase ist die Änderung von fehlerhaftem Code etwas teurer als die Änderung von sauberem Code.

Wenn wir jedoch zu den Wartungs- und Refactoring-Phasen übergehen, vergrößert sich die Lücke ERHEBLICH, wobei schlechter Code fast DOPPELT so viel kostet wie sauberer Code.

In der Legacy-Phase erreicht fehlerhafter Code 100 % Kosten, jetzt ist die Aktualisierung EXTREM teuer, während sauberer Code mit 45 % leichter zu verwalten bleibt.

Zweifellos ist schlechter Code ein KOSTENLOSES Problem in der Softwareentwicklung.

---

10 kugelsichere Regeln zum Schreiben von sauberem Code

1. Verwenden Sie Namen, die etwas bedeuten

Ihre Variablen oder Funktionen mit b oder x zu benennen, ist ein Verbrechen. Nennen Sie sie, wie sie sind.

// Weak and vague
let b = 5;

// Strong and clear
let numberOfUsers = 5;

Menschen, die unklare Namen schreiben wollen ihre Fehler nicht eingestehen. Sei nicht diese Person.

---

2. Halten Sie die Funktionen laserfokussiert (SRP)

Eine Funktion sollte eine Sache tun – und zwar perfekt. Dies wird als Single-Responsibility-Prinzip (SRP) bezeichnet.

Guter Code ist wie ein Hammer. Es trifft EINEN Nagel, nicht zehn.

// Clean: One job, one focus
function calculateTotal(a, b) {
    return a + b;
}

function logTotal(user, total) {
    console.log(`User: ${user}, Total: ${total}`);
}

// Dirty: Trying to do EVERYTHING
function calculateAndLogTotal(a, b, user) {
    let total = a + b;
    console.log(`User: ${user}, Total: ${total}`);
}

Wenn Sie Aufgaben vermischen, vermischen Sie VERWIRRUNG mit Katastrophe.

---

3. Hören Sie auf, Kommentare als Krücke zu verwenden

Sie erklären nicht, was eine Tür JEDES Mal tut, wenn jemand einen Raum betritt. Ihr Code sollte genauso funktionieren.

// Clean: Self-explanatory
let userAge = 25;

// Messy: Needs an explanation
let a; // This means "age of the user"

Kommentare sind nicht schlecht, aber wenn Ihr Code nicht für sich allein stehen kann, sind Sie bereits gescheitert.

---

4. Machen Sie es lesbar

Wenn jemand, der Ihren Code liest, das Gefühl hat, ein Rätsel zu lösen,Sie sind BEREITS zum Unruhestifter geworden.

// Clean: Reads like a story
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Messy: Feels like chaos
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

Lesbarer Code ist nicht nur für andere – er ist für Sie in sechs Monaten.

---

5. Testen Sie alles, was Sie schreiben

Wenn Sie zu faul sind, Tests zu schreiben, beschweren Sie sich NICHT, wenn Ihr Code kaputt geht.

class Calculator {
    add(a, b) { return a + b; }
    subtract(a, b) { return a - b; }
}

// Test it (Unit Test)
const calculator = new Calculator();
console.assert(calculator.add(2, 3) === 5, "Addition failed");
console.assert(calculator.subtract(5, 3) === 2, "Subtraction failed");

Tests sind Ihre Versicherungspolice. Ignorieren Sie sie und Sie verspielen Ihre Zeit.

---

6. Vorsicht vor Abhängigkeiten

Abhängigkeiten sind wie Deals. Holen Sie sich die RICHTIGEN und Sie GEWINNEN. Wenn Sie eine schlechte Wahl treffen, sind Sie auf etwas fixiert, das Sie bereuen werden.

// Dependency: Sending emails with Nodemailer
const nodemailer = require('nodemailer');
function sendEmail(to, subject, message) {
    const transporter = nodemailer.createTransport({ /* config */ });
    return transporter.sendMail({ from: "you@example.com", to, subject, text: message });
}

Vermeiden Sie Hardcodierungsabhängigkeiten. Verwenden Sie Abstraktion oder Konfigurationsdateien für eine sichere Wartung.

Dies ist nur ein Beispiel. Als Entwickler können Sie HUNDERTE Bibliotheken oder Abhängigkeiten verwenden.

Ich sage nicht, dass man sich nicht auf sie verlassen sollte. Heutzutage ist es schwierig, sie zu vermeiden. Sie sollten jedoch sehr vorsichtig sein, BEVOR Sie sie in Ihren Codierungsprojekten installieren.

Sie sollten die Sicherheit, Leistung, Qualität oder Funktionalität der Softwaresysteme einer Organisation überprüfen. Denn Sie bergen manchmal Risiken, die Ihr GESAMTES Projekt ruinieren können.

Kontrollieren Sie immer Ihre Werkzeuge, lassen Sie sich nicht von ihnen kontrollieren.

---

7. Organisieren Sie Projekte wie ein Chef

Ein gut organisiertes Projekt ist der Unterschied zwischeneinem Flohmarkt und einer High-End- Boutique.

myProject
├── src
│   ├── components
│   ├── services
│   ├── utils
└── tests

So sollte JEDER Ordner für dieses Projekt organisiert sein:

Wenn Ihre Codebasis wie eine Müllschublade aussieht, haben Sie bereits den Respekt vor Ihrem zukünftigen Selbst verloren.

Die solide Projektstruktur einer E-Mail-App:
Nehmen wir an, Sie erstellen eine Anwendung, die E-Mails an Benutzer sendet. Ihre Chef-ähnliche, unzerbrechliche SOLID-Projektstruktur sollte wie folgt aussehen:

---

8. Seien Sie bei der Formatierung konsistent

Programmieren Sie nicht wie eine Person mit 10 Persönlichkeiten. Achten Sie auf eine konsistente Formatierung.

Verwenden Sie Tools wie Prettier oder ESLint, um Ihren KONSISTENTEN Stil durchzusetzen. Wenn jede Datei anders aussieht, entsteht ein Chaos, das NIEMAND beheben möchte.

Ich würde sagen, dass die Konsistenz der Formatierung ein Grundprinzip von sauberem Code ist, da sie die Lesbarkeit gewährleistet.

Schauen Sie mal rein...

Verwenden Sie 2 oder 4 Leerzeichen für Einrückungen konsistent in Ihrer gesamten Codebasis. Vermeiden Sie Tabulatoren, um Einheitlichkeit über verschiedene Editoren hinweg zu gewährleisten.

Beschränken Sie die Zeilen auf maximal 100-120 Zeichen, um horizontales Scrollen zu verhindern und die Lesbarkeit zu verbessern.

Gruppieren Sie verwandte Logik zusammen und trennen Sie Codeblöcke mit Leerzeilen, um Hervorhebung ihren Zweck zu

hervorzuheben

. Abschließend vermeiden Sie eine übermäßige Ausrichtung des Codes; Lassen Sie stattdessen

Einrückungen

---

den Fluss der Logik auf natürliche Weise leiten.

9. Stoppen Sie die Hardcodierung von Werten

Hardcoding ist als Anstrengung getarnte Faulheit. Schauen Sie mal vorbei:

// Weak and vague
let b = 5;

// Strong and clear
let numberOfUsers = 5;

Hardcodierung ist also die

Abkürzung

---

, die Sie von der Klippe katapultiert.

10. Halten Sie die Funktionen kurz

Wenn Ihre Funktion länger als 20 Zeilen ist,
versucht sie wahrscheinlich, zu viel zu tun.

Unterteilen Sie sie.

// Clean: One job, one focus
function calculateTotal(a, b) {
    return a + b;
}

function logTotal(user, total) {
    console.log(`User: ${user}, Total: ${total}`);
}

// Dirty: Trying to do EVERYTHING
function calculateAndLogTotal(a, b, user) {
    let total = a + b;
    console.log(`User: ${user}, Total: ${total}`);
}

Kurzfunktionen sind scharfe Funktionen.

Sie haben JEDES Mal ins Schwarze getroffen.

---

??Weihnachtsgewinnspiel!

JEDER kann chaotischen Code schreiben. Sogar KI kann Müll produzieren. Aber sauberen Code schreiben? Das ist

die Fähigkeit, die die Amateure von den professionellen Programmierern unterscheidet.

Du willst die Softwareentwicklung dominieren?

Schreiben Sie sauberen Code

. So einfach ist das.

Wie schreibe ich dann sauberen Code?

Lassen Sie mich Ihnen etwas sagen – was Sie gerade in diesem Artikel gelesen haben, ist NICHTS weiter als ein Tröpfchen aus dem Ozean an Wissen in meinem Buch

Clean Code Zero to One.

Diese 10 Regeln? Sie sind nur die OBERFLÄCHE.

Das Buch geht tief in JEDES Prinzip, JEDE Regel und JEDE Technik ein und wird so klar und detailliert erklärt, dass Sie sie NIEMALS vergessen werden.

Ich habe es vollgepackt mit Tausenden digitalen Illustrationen und Szenarien aus der realen Welt, die Sie nicht nur lehren, sondern Sie wie nichts anderes in die Welt des sauberen Programmierens entführen Habe es je gesehen.

Die Wahrheit ist: Unordentliche Programmierer ÜBERLEBEN NICHT. Sie ertrinken in ihrem eigenen Chaos. Saubere Programmierer dominieren. Sie schreiben Software, die die Zeit überdauert, und sie kämpfen NIEMALS mit Fehlern, die sie nicht beheben können, oder mit Funktionen, die sie NICHT hinzufügen KÖNNEN.

Wenn Sie es ernst meinen, die Art und Weise zu manifestieren, wie Sie Code schreiben, ist dieses Buch keine Option – es ist ein Must-Have.

Und weil Weihnachten ist, mache ich es Ihnen leicht. Verwenden Sie den Aktionscode MERRYCHRISTMAS, um 50 % Rabatt zu erhalten.

Aber warten Sie nicht zu lange – dieses Angebot endet am 31. Dezember 2024.

Klicken Sie auf den Link unten, um das Buch zu erhalten.

? Erhalten Sie jetzt Clean Code Zero to One

Die Wahl liegt bei Ihnen. Sie können weiterhin chaotischen Code schreiben und dabei Zeit und Energie verschwenden, oder Sie können die KONTROLLE ÜBERNEHMEN, lernen, Ihre Projekte zu DOMINIEREN und Software wie ein BOSS ZU BAUEN.

? Folgen Sie mir für mehr: @shahancd
? Mein wöchentlicher Newsletter:Horscoder

---

Lesen Sie mehr: Saubere, wiederverwendbare Komponenten in React schreiben

Das obige ist der detaillierte Inhalt vonSo schreiben Sie sauberen Code – Tipps für Entwickler mit Beispielen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!