Was ist Clean Code und warum ist er wichtig?

Das Schreiben von Code, der nur einmal verwendet werden muss, kann ganz 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 zu einem späteren Zeitpunkt wahrscheinlich 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

ist

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

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 Prinzipien 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 von entscheidender Bedeutung ist, wollen wir uns mit einigen Best Practices und Prinzipien befassen, die Ihnen beim Schreiben von sauberem Code 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 Nummern

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. Vermeiden Sie Kodierungen. 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. Verwenden Sie Kommentare nur dort, wo sie benötigt werden
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. Always try to explain yourself in code.
2. Don't be redundant.
3. Don't add obvious noise.
4. Don't use closing brace comments.
5. Don't comment out code. Just remove.
6. Use as explanation of intent.
7. Use as clarification of code.
8. Use as warning of consequences.

Example

// 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

Here we can see comments are used to define steps which be easily understand by reading the code. This comments are unnecessary and making code cluttered. Let's see correct use of comments.

Improved 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

In above example comments are used only where it is needed. This is good practice to make your code clean.

4. Write Functions That Do Only One Thing
When you write functions, don't add too many responsibilities to them. Follow the Single Responsibility Principle (SRP). This makes the function easier to understand and simplifies writing unit tests for it.

Functions rules

1. Keep it Small.
2. Do one thing.
3. Use descriptive names.
4. Prefer fewer arguments.
5. Split method into several independent methods that can be called from the client.

Example

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);

In the above example, we can see a function that fetches data using an API and processes it. This can be done by another function. Currently, the data processing function is very small, but in a production-level project, data processing can be very complex. At that time, it is not a good practice to keep this in the same function. This will make your code complex and hard to understand in one go.
Let's see the clean version of this.

Improved 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 the this example, the responsibilities are separated: the fetchData function handles the API call, and the processData function handles data processing. This makes the code easier to understand, maintain, and test.

5. Avoid Code Duplication (Follow DRY Principle - Don't Repeat Your Self)

To enhance code maintainability and cleanliness, strive to create reusable functions or reuse existing code whenever possible. For instance, if you are fetching data from an API to display on a page, you would write a function that retrieves the data and passes it to a renderer for UI display. If the same data needs to be shown on another page, instead of writing the same function again, you should move the function to a utility file. This allows you to import and use the function in both instances, promoting reusability and consistency across your codebase.

Other General Rules for writing Clean Code

• Follow standard conventions(For JavaScript Camel Case).
• Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
• Boy scout rule. Leave the campground cleaner than you found it.
• Always find root cause. Always look for the root cause of a problem.
• Write code which is easy to understand

Implement this Practices and Principles from today to write Clean Code.

Das obige ist der detaillierte Inhalt vonWas ist Clean Code und warum ist er wichtig?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!