Das Schreiben von Code, der nur einmal verwendet werden muss, kann nach Ihren Wünschen erfolgen. In den meisten Fällen ist es jedoch unerlässlich, sich an Best Practices zu halten und sauberen Code beizubehalten.

Denken Sie daran, dass Ihr Code wahrscheinlich zu einem späteren Zeitpunkt von einem anderen Entwickler oder sogar von Ihnen selbst gelesen wird. Wenn es soweit ist, sollte Ihr Code selbsterklärend sein. Jede Variable, Funktion und jeder Kommentar sollte präzise, ​​sauber und leicht verständlich sein. Dieser Ansatz erleichtert nicht nur die Wartung, sondern fördert auch die Zusammenarbeit und Effizienz innerhalb Ihres Entwicklungsteams.

Wenn also jemand (oder Sie) zurückkommt, um Ihren Code hinzuzufügen oder zu ändern, ist es leicht zu verstehen, was jede Codezeile bewirkt. Andernfalls werden Sie die meiste Zeit damit verbringen, den Code zu verstehen. Das gleiche Problem tritt bei einem neuen Entwickler auf, der an Ihrer Codebasis arbeitet. Sie werden den Code nicht verstehen, wenn er nicht sauber ist. Daher ist es sehr wichtig, sauberen Code zu schreiben.

Was ist Clean Code?

Sauberer Code bezieht sich grundsätzlich auf den Code, der

1. Einfach zu verstehen
2. Einfach zu debuggen
3. Leicht zu pflegen
4. Kommentare sind gut geschrieben, kurz und verständlich
5. Kein doppelter (redundanter) Code und folgt der KISS-Regel (Keep it simple, Dumm!)

Um sauberen Code zu schreiben, muss der Entwickler die Konsistenz des Codes aufrechterhalten und die Best Practices für die jeweilige Sprache befolgen.

Warum ist sauberer Code wichtig?

Wenn Teams die Grundsätze sauberen Codes befolgen, wird die Codebasis einfacher zu lesen und zu navigieren. Dies hilft Entwicklern, den Code schnell zu verstehen und mit der Mitarbeit zu beginnen. Hier sind einige Gründe, warum sauberer Code wichtig ist.

1. Lesbarkeit und Wartung: Der Code ist leicht zu lesen und zu verstehen, wenn er gut geschrieben ist, gute Kommentare enthält und Best Practices befolgt. Sobald ein Problem oder ein Fehler auftritt, wissen Sie genau, wo Sie ihn finden können.

2. Debuggen: Sauberer Code ist klar und einfach gestaltet und erleichtert das Auffinden und Verstehen bestimmter Abschnitte der Codebasis. Eine klare Struktur, aussagekräftige Variablennamen und klar definierte Funktionen erleichtern die Identifizierung und Lösung von Problemen.

3. Verbesserte Qualität und Zuverlässigkeit: Sauberer Code folgt den Best Practices bestimmter Sprachen und priorisiert den gut strukturierten Code. Es erhöht die Qualität und verbessert die Zuverlässigkeit. Dadurch werden Fehler vermieden, die durch fehlerhaften und unstrukturierten Code entstehen können.

Da wir nun verstanden haben, warum sauberer Code so wichtig ist, werfen wir einen Blick auf einige Best Practices und Prinzipien, die Ihnen beim Schreiben sauberen Codes helfen.

Prinzipien von Clean Code

Um großartigen Code zu erstellen, muss man sich an die Prinzipien und Praktiken von sauberem Code halten, wie zum Beispiel die Verwendung kleiner, klar definierter Methoden.

Sehen wir uns das im Detail an.

1. Vermeiden Sie hartcodierte Zahlen

Anstatt den Wert direkt zu verwenden, können wir eine Konstante verwenden und ihr diesen Wert zuweisen. Wenn wir diesen Wert in Zukunft aktualisieren müssen, müssen wir ihn also nur an einer Stelle aktualisieren.

Beispiel

function getDate() {
  const date = new Date();
  return "Today's date: "   date;
}

function getFormattedDate() {
  const date = new Date().toLocaleString();
  return "Today's date: "   date;
}

In diesem Code gibt es irgendwann eine Änderung, die anstelle von „Heutiges Datum:“ zu „Datum:“ wird. Dies kann verbessert werden, indem diese Zeichenfolge einer Variablen zugewiesen wird.

Verbesserter Code:

const todaysDateLabel = "Today's date: ";

function getDate() {
  const date = new Date();
  return todaysDateLabel   date;
}

function getFormattedDate() {
  const date = new Date().toLocaleString();
  return todaysDateLabel   date;
}

Im obigen Code ist es einfach, die Datumszeichenfolge bei Bedarf zu ändern. Es verbessert die Wartbarkeit.

2. Verwenden Sie aussagekräftige und beschreibende Namen
Anstatt überall gebräuchliche Variablennamen zu verwenden, können wir etwas aussagekräftigere Namen verwenden, was selbsterklärend ist. Der Variablenname selbst sollte seine Verwendung definieren.

Namensregeln

1. Wählen Sie aussagekräftige und eindeutige Namen.
2. Machen Sie eine sinnvolle Unterscheidung.
3. Verwenden Sie aussprechbare Namen.
4. Verwenden Sie durchsuchbare Namen.
5. Ersetzen Sie magische Zahlen durch benannte Konstanten.
6. Kodierungen vermeiden. Hängen Sie keine Präfixe oder Typinformationen an.

Beispiel

// Calculate the area of a rectangle
function calc(w, h) {
    return w * h;
}

const w = 5;
const h = 10;
const a = calc(w, h);
console.log(`Area: ${a}`);

Hier ist der Code korrekt, aber es gibt einige Unklarheiten im Code. Sehen Sie sich den Code an, in dem beschreibende Namen verwendet werden.

Verbesserter Code

// Calculate the area of a rectangle
function calculateRectangleArea(width, height) {
    return width * height;
}

const rectangleWidth = 5;
const rectangleHeight = 10;
const area = calculateRectangleArea(rectangleWidth, rectangleHeight);
console.log(`Area of the rectangle: ${area}`);

Hier sind alle Variablennamen selbsterklärend. Dadurch wird der Code leichter verständlich und die Codequalität verbessert sich.

3. Kommentar nur dort verwenden, wo er benötigt wird
Sie müssen nicht überall Kommentare schreiben. Schreiben Sie einfach dort, wo es nötig ist, und schreiben Sie kurz und leicht verständlich. Zu viele Kommentare führen zu Verwirrung und einer unübersichtlichen Codebasis.

Kommentarregeln

1. Versuchen Sie immer, sich im Code zu erklären.
2. Sei nicht überflüssig.
3. Kein offensichtliches Rauschen hinzufügen.
4. Verwenden Sie keine Kommentare in schließenden Klammern.
5. Kommentieren Sie den Code nicht aus. Einfach entfernen.
6. Verwendung als Absichtserklärung.
7. Zur Verdeutlichung des Codes verwenden.
8. Verwendung als Warnung vor Konsequenzen.

Beispiel

// Function to get the square of a number
function square(n) {
    // Multiply the number by itself
    var result = n * n; // Calculate square
    // Return the result
    return result; // Done
}

var num = 4; // Number to square
var squared = square(num); // Call function

// Output the result
console.log(squared); // Print squared number

Hier können wir sehen, dass Kommentare verwendet werden, um Schritte zu definieren, die durch das Lesen des Codes leicht verständlich sind. Diese Kommentare sind unnötig und machen den Code unübersichtlich. Sehen wir uns die korrekte Verwendung von Kommentaren an.

Verbesserter Code

/**
 * Returns the square of a number.
 * @param {number} n - The number to be squared.
 * @return {number} The square of the input number.
 */
function square(n) {
    return n * n;
}

var num = 4;
var squared = square(num); // Get the square of num

console.log(squared); // Output the result

Im obigen Beispiel werden Kommentare nur dort verwendet, wo sie benötigt werden. Dies ist eine gute Vorgehensweise, um Ihren Code sauber zu machen.

4. Funktionen schreiben, die nur eine Sache tun
Fügen Sie beim Schreiben von Funktionen nicht zu viele Verantwortlichkeiten hinzu. Befolgen Sie das Single-Responsibility-Prinzip (SRP). Dies macht die Funktion verständlicher und vereinfacht das Schreiben von Komponententests dafür.

Funktionsregeln

1. Halten Sie es klein.
2. Eine Sache machen.
3. Verwenden Sie beschreibende Namen.
4. Weniger Argumente bevorzugen.
5. Methode in mehrere unabhängige Methoden aufteilen, die vom Client aufgerufen werden können.

Beispiel

async function fetchDataAndProcess(url) {
    // Fetches data from an API and processes it in the same function
    try {
        const response = await fetch(url);
        const data = await response.json();

        // Process data (e.g., filter items with value greater than 10)
        const processedData = data.filter(item => item.value > 10);

        console.log(processedData);
    } catch (error) {
        console.error('Error:', error);
    }
}

// Usage
const apiUrl = 'https://api.example.com/data';
fetchDataAndProcess(apiUrl);

Im obigen Beispiel sehen wir eine Funktion, die Daten mithilfe einer API abruft und verarbeitet. Dies kann durch eine andere Funktion erfolgen. Derzeit ist die Datenverarbeitungsfunktion sehr klein, aber in einem Projekt auf Produktionsebene kann die Datenverarbeitung sehr komplex sein. Zu diesem Zeitpunkt ist es keine gute Praxis, dies in derselben Funktion beizubehalten. Dadurch wird Ihr Code auf einmal komplex und schwer verständlich.
Sehen wir uns die saubere Version davon an.

Verbesserter Code

async function fetchData(url) {
    // Fetches data from an API
    try {
        const response = await fetch(url);
        return await response.json();
    } catch (error) {
        console.error('Error:', error);
        throw error;
    }
}

function processData(data) {
    // Processes the fetched data (e.g., filter items with value greater than 10)
    return data.filter(item => item.value > 10);
}

// Usage
const apiUrl = 'https://api.example.com/data';

fetchData(apiUrl)
    .then(data => {
        const processedData = processData(data);
        console.log(processedData);
    })
    .catch(error => {
        console.error('Error:', error);
    });

In diesem Beispiel sind die Verantwortlichkeiten getrennt: Die Funktion fetchData übernimmt den API-Aufruf und die Funktion processData übernimmt die Datenverarbeitung. Dadurch ist der Code leichter zu verstehen, zu warten und zu testen.

5. Vermeiden Sie Codeduplizierung (folgen Sie dem DRY-Prinzip – wiederholen Sie sich nicht)

Um die Wartbarkeit und Sauberkeit des Codes zu verbessern, versuchen Sie, wann immer möglich, wiederverwendbare Funktionen zu erstellen oder vorhandenen Code wiederzuverwenden. Wenn Sie beispielsweise Daten von einer API abrufen, um sie auf einer Seite anzuzeigen, schreiben Sie eine Funktion, die die Daten abruft und sie zur Anzeige auf der Benutzeroberfläche an einen Renderer übergibt. Wenn dieselben Daten auf einer anderen Seite angezeigt werden müssen, sollten Sie die Funktion in eine Dienstprogrammdatei verschieben, anstatt dieselbe Funktion erneut zu schreiben. Dadurch können Sie die Funktion in beiden Instanzen importieren und verwenden und so die Wiederverwendbarkeit und Konsistenz in Ihrer gesamten Codebasis fördern.

Andere allgemeine Regeln zum Schreiben von sauberem Code

• Befolgen Sie die Standardkonventionen (für JavaScript Camel Case).
• Halten Sie es einfach blöd. Einfacher ist immer besser. Reduzieren Sie die Komplexität so weit wie möglich.
• Pfadfinderregel. Hinterlassen Sie den Campingplatz sauberer, als Sie ihn vorgefunden haben.
• Finden Sie immer die Ursache. Suchen Sie immer nach der Ursache eines Problems.
• Schreiben Sie Code, der leicht zu verstehen ist

Implementieren Sie diese Praktiken und Prinzipien ab heute, um sauberen Code zu schreiben.