Heim  >  Artikel  >  Web-Frontend  >  So schreiben Sie sauberen Code

So schreiben Sie sauberen Code

Mary-Kate Olsen
Mary-Kate OlsenOriginal
2024-10-23 16:39:02347Durchsuche

Warum sauberen Code schreiben? ⛩️

How to write clean code
Stellen Sie sich vor, Sie würden versuchen, etwas in einem unordentlichen Raum zu finden – Sie würden Zeit mit der Suche verschwenden, oder?

Das Gleiche gilt für unordentlichen Code! Es ist SCHWIERIGER, Probleme zu finden oder zu verstehen, was passiert. Mit sauberem Code können Sie dieses Chaos vermeiden.

Wissen Sie was? Indem Sie sauberen Code schreiben, sparen Sie auch anderen Entwicklern wertvolle Zeit. Vertrauen Sie mir... Sie retten die Welt! ?


7 Tipps zum Schreiben von sauberem Code?

How to write clean code

1. Verwenden Sie aussagekräftige Namen

Wenn Sie eine Variable oder Funktion erstellen, geben Sie ihr einen Namen, der angibt, was sie tut.

Stellen Sie sich das so vor, als würden Sie einen Ordner auf Ihrem Computer benennen. Anstatt es b zu nennen, nennen Sie es numberOfUsers. Auf diese Weise benötigen Sie keine zusätzlichen Kommentare, um zu erklären, was b ist.

Beispiel:

let numberOfUsers = 5; // Clear and easy to understand

2. Befolgen Sie das Single-Responsibility-Prinzip (SRP)

Eine Funktion sollte eine Aufgabe erledigen, und zwar gut.

Dies erleichtert das Verständnis und die Fehlerbehebung bei Bedarf. Es ist, als hätte man ein Werkzeug für eine Aufgabe, wie einen Bleistift zum Schreiben und eine Schere zum Schneiden.

How to write clean code

Beispiel:

function addNumbers(a, b) {
    return a + b;
}

Diese Funktion fügt nur zwei Zahlen hinzu. Es macht nichts anderes.

3. Vermeiden Sie unnötige Kommentare

Anstatt überall Kommentare hinzuzufügen, versuchen Sie, Ihren Code selbsterklärend zu machen, indem Sie gute Namen verwenden.

Verwenden Sie Kommentare nur, wenn etwas knifflig ist oder eine besondere Anmerkung erfordert. Zu viele Kommentare können die Leute verwirren. ??

Beispiel:

// Good: Clear name, no extra comment needed
let userAge = 25; 

// Bad: Unclear name, needs a comment
let a; // age of the user

4. Machen Sie Ihren Code lesbar

Verwenden Sie Leerzeichen, Einrückungen und Zeilenumbrüche, um Ihren Code übersichtlich zu halten.

Genau wie beim Schreiben eines Absatzes sollten Sie Ihren Code in kleinere Teile aufteilen, damit nicht alles in einer Zeile steht.

Beispiel:

// Good Code
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Bad Code
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

5. Schreiben Sie Unit-Tests

Unit-Tests sind Überprüfungen Ihres Codes.

Sie sorgen dafür, dass alles so funktioniert, wie es soll. Wenn Sie Ihren Code ändern, werden Ihnen diese Tests mitteilen, ob etwas kaputt geht.

Beispiel:

function add(a, b) {
    return a + b;
}

// Test
console.assert(add(2, 3) === 5, 'Test failed: 2 + 3 should be 5');

6. Seien Sie vorsichtig mit Abhängigkeiten

Wenn Sie Software erstellen, versuchen Sie, die Dinge getrennt zu halten, damit sie nicht zu sehr voneinander abhängig sind.

Zum Beispiel kann eine Spülmaschine in jeder Küche stehen, nicht nur in einer bestimmten Küche. Auf diese Weise ist es einfacher zu verwalten.

How to write clean code

7. Organisieren Sie Ihr Projekt

Halten Sie Ihre Dateien und Ordner organisiert, genau wie Sie Ihren Schreibtisch sauber halten. Dies erleichtert das Auffinden von Dingen, wenn Ihr Projekt größer wird.

How to write clean code

Beispiel:

  • Verwenden Sie Ordner wie Komponenten, Dienste und Dienstprogramme in Ihrem Projekt.
  • Bewahren Sie ähnliche Dateien zusammen, damit Sie wissen, wo Sie sie suchen müssen.

✅ Empfehlung

Verwenden Sie diese druckbare Backend Developer Notion-Vorlage, um Ihren Fortschritt zu verfolgen! ?

Entwickleranfänger haben oft Schwierigkeiten mit der Auswahl des richtigen Tech-Stacks, was zu Zeitverschwendung und Motivationsverlust führt.

Daher habe ich in Notion eine wunderschön gestaltete und sehr einfach zu befolgende 6-monatige Backend-Entwickler-Roadmap erstellt, damit Sie Ihren Fortschritt verfolgen und an Ihren Zielen festhalten können!

How to write clean code

Diese Roadmap:

  • ?️ Bietet einen klaren Weg, um Verwirrung zu vermeiden.
  • ? Hilft Ihnen, motiviert zu bleiben, indem es Ihnen zeigt, wo Sie beginnen und enden sollen.
  • ? Folgt einem strukturierten Plan, ähnlich einem Lehrplan.
  • ? Organisiert Ihr Lernen mit wöchentlichen Zielen für Tools und Sprachen.
  • ⏳ Stellt die Fertigstellung in 6 Monaten sicher und deckt alles ab, was Sie brauchen.
  • ? Verfügt über ein schönes Design für eine einfache Navigation.

How to write clean code


Abschluss ?

Sauberen Code zu schreiben ist wie der Bau eines starken Fundaments für ein Haus. Es hält alles in Ordnung und erleichtert das Hinzufügen neuer Dinge oder das Beheben von Problemen ohne großen Aufwand.

Befolgen Sie diese 7 Tipps, um Ihren Code einfach, lesbar und benutzerfreundlich zu gestalten!

Weiterlesen: Fähigkeiten, um in 6 Monaten Backend-Entwickler zu werden (Roadmap)

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

Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn