Best Practices zum Schreiben von sauberem und wartbarem JavaScript-Code

1. Aussagekräftige Variablen- und Funktionsnamen:
Tipp: Verwenden Sie beschreibende Namen, die den Zweck der Variablen oder Funktion klar angeben.
Beispiel:

Copy code
// Bad
const x = calculate(5);

// Good
const totalPrice = calculatePrice(5);

2. Beschreibende Kommentare:
Tipp: Schreiben Sie prägnante, aber aussagekräftige Kommentare, um komplexe Logik oder Absichten zu erläutern. Kommentare sollten klarstellen, warum etwas getan wird, und nicht, was getan wird (was aus dem Code selbst klar hervorgehen sollte).
Beispiel:

// Bad
// Loops through the array
array.forEach(item => doSomething(item));

// Good
// Process each item to filter out non-active users
array.forEach(item => filterActiveUsers(item));

3. Prinzip der Einzelverantwortung:
Tipp: Stellen Sie sicher, dass Funktionen und Methoden eine bestimmte Aufgabe ausführen, damit sie wiederverwendbar und leicht zu debuggen sind.
Beispiel:

// Bad
function handleUserLoginAndDisplayUserProfile() { /* multiple tasks */ }

// Good
function handleUserLogin() { /* one task */ }
function displayUserProfile() { /* one task */ }

4. Konsistente Formatierung und Stil:
Tipp: Verwenden Sie eine konsistente Codeformatierung (Einrückungen, Leerzeichen) und befolgen Sie Stilrichtlinien (camelCase für Variablen, PascalCase für Klassen usw.).
Beispiel:

js
Copy code
// Bad
function fetchData(){return 'data'}

// Good
function fetchData() {
  return 'data';
}

5. Vermeiden Sie magische Zahlen und Zeichenfolgen:
Tipp: Verwenden Sie benannte Konstanten anstelle von fest codierten Zahlen oder Zeichenfolgen, wodurch Ihr Code besser lesbar und wartbar ist.
Beispiel:

// Bad
const discount = total * 0.1;

// Good
const DISCOUNT_RATE = 0.1;
const discount = total * DISCOUNT_RATE;

6. Modularen Code schreiben:
Tipp: Teilen Sie Ihren Code in kleinere, wiederverwendbare Module oder Funktionen auf. Dies erhöht die Wiederverwendbarkeit und Wartbarkeit.
Beispiel:

// Bad
function processOrder(order) { /* many tasks */ }

// Good
function validateOrder(order) { /* one task */ }
function calculateTotal(order) { /* one task */ }

7. Nutzen Sie sinnvolle Fehlerbehandlung:
Tipp: Fehler richtig erkennen und behandeln und Entwicklern oder Benutzern aussagekräftiges Feedback geben.
Beispiel:

// Bad
try {
  processOrder(order);
} catch (e) {
  console.log(e);
}

// Good
try {
  processOrder(order);
} catch (error) {
  console.error(`Failed to process order: ${error.message}`);
}

8. DRY-Prinzip (Wiederholen Sie sich nicht):
Tipp: Vermeiden Sie die Duplizierung von Code, indem Sie allgemeine Logik in Funktionen oder Module umgestalten.
Beispiel:

// Bad
const userAge = getUserAge();
const userName = getUserName();

// Good
function getUserDetails() {
  return {
    age: getUserAge(),
    name: getUserName(),
  };
}

Das obige ist der detaillierte Inhalt vonBest Practices zum Schreiben von sauberem und wartbarem JavaScript-Code. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!