Die Softwareentwicklung erfordert gute Systementwürfe und Kodierungsstandards. Im nachstehenden Diagramm sind 10 gute Kodierungsgrundsätze aufgeführt.¹

• 01 Code-Spezifikationen befolgen
  Wenn wir Code schreiben, ist es wichtig, dass wir uns an die etablierten Normen der Branche halten, z. B. "PEP 8" oder "Google Java Style". Die Einhaltung einer Reihe vereinbarter Code-Spezifikationen gewährleistet, dass die Qualität des Codes konsistent und lesbar ist.
• 02 Dokumentation und Kommentare
  Guter Code sollte klar dokumentiert und kommentiert sein, um komplexe Logik und Entscheidungen zu erläutern, und Kommentare sollten erklären, warum ein bestimmter Ansatz gewählt wurde ("Warum") und nicht, was genau getan wird ("Was"). Die Dokumentation und die Kommentare sollten klar und prägnant sein und ständig aktualisiert werden.
• 03 Robustheit
  Guter Code sollte in der Lage sein, eine Vielzahl unerwarteter Situationen und Eingaben zu bewältigen, ohne abzustürzen oder unvorhersehbare Ergebnisse zu produzieren. Der gängigste Ansatz besteht darin, Ausnahmen abzufangen und zu behandeln.
• 04 Befolgen Sie das SOLID-Prinzip
  "Single Responsibility", "Open/Closed", "Liskov Substitution", "Interface Segregation" und "Dependency Inversion" - diese fünf Prinzipien (kurz SOLID) sind die Eckpfeiler für das Schreiben von skalierbarem und einfach zu wartendem Code.
• 05 Testen leicht gemacht
  Die Testbarkeit von Software ist besonders wichtig. Guter Code sollte leicht zu testen sein, indem man versucht, die Komplexität der einzelnen Komponenten zu reduzieren, und indem man automatisierte Tests unterstützt, um sicherzustellen, dass er sich wie erwartet verhält.
• 06 Abstraktion
  Abstraktion erfordert, dass wir die Kernlogik extrahieren und die Komplexität verbergen, wodurch der Code flexibler und generischer wird. Guter Code sollte einen moderaten Abstraktionsgrad aufweisen, der weder überdimensioniert ist noch die langfristige Erweiterbarkeit und Wartbarkeit vernachlässigt.
• 07 Design Patterns verwenden, aber nicht überdesignen
  Entwurfsmuster können uns bei der Lösung einiger gängiger Probleme helfen. Allerdings hat jedes Muster seine Anwendungsszenarien. Die übermäßige oder falsche Verwendung von Entwurfsmustern kann Ihren Code komplexer und schwer verständlich machen.
• 08 Globale Abhängigkeiten vermindern
  Wenn wir globale Variablen und Instanzen verwenden, können wir uns in Abhängigkeiten und einer verwirrenden Zustandsverwaltung verzetteln. Guter Code sollte sich auf lokalisierte Zustände und Parameterübergabe stützen. Funktionen sollten frei von Nebeneffekten sein.
• 09 Kontinuierliches Refactoring
  Guter Code ist wartbar und erweiterbar. Kontinuierliches Refactoring reduziert technische Schulden, indem Probleme so früh wie möglich erkannt und behoben werden.
• 10 Sicherheit hat höchste Priorität
  Guter Code sollte häufige Sicherheitsschwachstellen vermeiden.

1. Dieser Artikel ist eine Wiedergabe des Inhalts des bytebytego Newsletters. ihren Newsletter zu abonnieren wenn Sie mehr von ihnen wollen ↩︎