Zusammenfassung des sauberen Codes

Code ist sauber, wenn er leicht verständlich ist – für alle im Team. Sauberer Code kann von einem anderen Entwickler als seinem ursprünglichen Autor gelesen und verbessert werden. Mit der Verständlichkeit gehen Lesbarkeit, Veränderbarkeit, Erweiterbarkeit und Wartbarkeit einher.
Allgemeine Regeln

• Befolgen Sie die Standardkonventionen.
• Halte es einfach, dumm. Einfacher ist immer besser. Reduzieren Sie die Komplexität so weit wie möglich.
• Pfadfinderregel. Verlassen Sie den Campingplatz sauberer, als Sie ihn vorgefunden haben.
• Finden Sie immer die Ursache. Suchen Sie immer nach der Grundursache eines Problems.

Designregeln

1. Konfigurierbare Daten auf hohem Niveau halten.
2. Polymorphismus gegenüber if/else oder switch/case bevorzugen.
3. Separater Multithreading-Code.
4. Überkonfigurierbarkeit verhindern.
5. Verwenden Sie die Abhängigkeitsinjektion.
6. Befolgen Sie das Gesetz von Demeter. Eine Klasse sollte nur ihre direkten Abhängigkeiten kennen.

Tipps zur Verständlichkeit

1. Seien Sie konsequent. Wenn Sie etwas auf eine bestimmte Weise tun, machen Sie alle ähnlichen Dinge auf die gleiche Weise.
2. Verwenden Sie erklärende Variablen.
3. Randbedingungen kapseln. Randbedingungen sind schwer zu überblicken. Legen Sie die Verarbeitung für sie an einem Ort ab.
4. Dedizierte Wertobjekte dem primitiven Typ vorziehen.
5. Vermeiden Sie logische Abhängigkeiten. Schreiben Sie keine Methoden, die abhängig von etwas anderem in derselben Klasse korrekt funktionieren.
6. Vermeiden Sie negative Bedingungen.

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.

Funktionsregeln

1. Klein.
2. Tu eine Sache.
3. Verwenden Sie beschreibende Namen.
4. Bevorzugen Sie weniger Argumente.
5. Haben keine Nebenwirkungen.
6. Verwenden Sie keine Flag-Argumente. Methode in mehrere unabhängige Methoden aufteilen, die vom Client ohne Flag aufgerufen werden können.

Kommentarregeln

1. Versuchen Sie immer, sich im Code zu erklären.
2. Seien Sie nicht überflüssig.
3. Fügen Sie keine offensichtlichen Geräusche hinzu.
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.

Quellcodestruktur

1. Konzepte vertikal trennen.
2. Zugehöriger Code sollte vertikal dicht erscheinen.
3. Deklarieren Sie Variablen, die ihrer Verwendung nahe kommen.
4. Abhängige Funktionen sollten nahe beieinander liegen.
5. Ähnliche Funktionen sollten in der Nähe sein.
6. Funktionen nach unten platzieren.
7. Halten Sie die Warteschlangen kurz.
8. Verwenden Sie keine horizontale Ausrichtung.
9. Verwenden Sie Leerzeichen, um verwandte Dinge zu verknüpfen und schwach verwandte Dinge zu trennen.
10. Einrückung nicht unterbrechen.

Objekte und Datenstrukturen

1. Interne Struktur ausblenden.
2. Datenstrukturen bevorzugen.
3. Vermeiden Sie Hybridstrukturen (halb Objekt und halb Daten).
4. Sollte klein sein.
5. Tu eine Sache.
6. Geringe Anzahl von Instanzvariablen.
7. Die Basisklasse sollte nichts über ihre Derivate wissen.
8. Es ist besser, viele Funktionen zu haben, als Code an eine Funktion zu übergeben, um ein Verhalten auszuwählen.
9. Nicht-statische Methoden statischen Methoden vorziehen.

Tests

1. Eine Behauptung pro Test.
2. Lesbar.
3. Schnell.
4. Unabhängig.
5. Wiederholbar.

Code riecht

1. Steifigkeit. Die Software ist schwer zu ändern. Eine kleine Änderung führt zu einer Kaskade nachfolgender Änderungen.
2. Zerbrechlichkeit. Die Software bricht an vielen Stellen aufgrund einer einzigen Änderung ab.
3. Immobilität. Aufgrund der damit verbundenen Risiken und des hohen Aufwands können Sie Teile des Codes nicht in anderen Projekten wiederverwenden.
4. Unnötige Komplexität.
5. Unnötige Wiederholung.
6. Deckkraft. Der Code ist schwer zu verstehen.

Das ist viel, denke ich, aber es gibt noch mehr.
Lesen Sie das vollständige Buch.

Vielen Dank für das Lesen der Zusammenfassung. Ich hoffe, es hilft.

Website:
https://kaleemelahi.co

Kauf mir einen Kaffee:
https://buymeacoffee.com/kaleemelahi

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