Code-Strukturierung

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche
Unter Code-Strukturierung versteht man den durchdachten, logischen Aufbau eines Quellcodes. Ziel ist es, den Code so zu organisieren, dass er leicht verständlich, einfach wartbar und nachvollziehbar bleibt – sowohl für die Person, die ihn geschrieben hat, als auch für andere Entwickler, die später damit arbeiten müssen.

Gut strukturierter Code folgt klaren Regeln: Abschnitte sind übersichtlich gegliedert, Funktionen und Klassen haben eindeutige Aufgaben, und Variablen- sowie Funktionsnamen spiegeln ihre Bedeutung wider. Außerdem wird redundanter Code vermieden, indem wiederverwendbare Einheiten geschaffen werden.

Typische Techniken der Code-Strukturierung sind:

Eine gute Code-Struktur spart Zeit, verhindert Fehler und sorgt dafür, dass Projekte auch langfristig stabil, verständlich und erweiterbar bleiben. Sie ist damit einer der wichtigsten Grundpfeiler professioneller Softwareentwicklung.

Konsequente Formatierung

Einheitliche Einrückungen, klare Kommentierung und logische Gruppierung

Konsequente Formatierung gehört zu den wichtigsten Grundlagen guter Softwareentwicklung. Sie sorgt nicht nur dafür, dass Code „schön aussieht“, sondern erhöht Lesbarkeit, Verständlichkeit und Wartbarkeit erheblich. Konsistent formatierter Code reduziert Fehlerquellen, ermöglicht eine bessere Zusammenarbeit im Team und stellt sicher, dass der Aufbau eines Programms logisch nachvollziehbar bleibt.

Wichtige Prinzipien der konsequenten Formatierung:

  • Einheitliche Einrückungen: Jede logische Ebene (Block, Schleife, Bedingung) wird mit der gleichen Anzahl von Leerzeichen oder Tabs eingerückt.
  • Klarer Einsatz von Leerzeilen: Abschnitte, die logisch zusammengehören, stehen zusammen. Unterschiedliche Funktionsbereiche werden durch Leerzeilen getrennt.
  • Saubere Kommentierung: Kommentare erklären warum etwas passiert, nicht was passiert.
  • Logische Gruppierung: Variablen, Funktionen oder CSS-Regeln, die thematisch zusammengehören, stehen auch im Code zusammen.

Komplizierter Code wird durch Umstrukturierung lesbar gemacht.

HTML

<nav><ul><li><a href="#">Home</a></li><li><a href="#">Kontakt</a></li></ul></nav>

HTML lebt von Übersichtlichkeit — Verschachtelung muss sichtbar sein.

Einrückungen zeigen Verschachtelungen
<nav>
  <ul>
    <li><a href="#">Home</a></li>
    <li><a href="#">Kontakt</a></li>
  </ul>
</nav>



CSS

Genauso sollten CSS-Regelsätze nicht einzeilig sein:

.card{padding:1rem;color:#333;background:white;border-radius:.5em} .card h2{margin:0;color:black}

Neben einer einheitlichen Einrückung sollten die CSS-Eigenschaften alphabetisch sortiert sein, auch im Seiteninspektor werden sie so angezeigt.

CSS -aber sortiert!
.card {
  background: white;
  border-radius: .5em;
  color: #333;
  padding: 1rem;
}

.card h2 {
  color: black;
  margin: 0;
}

Konsequente Formatierung macht Strukturen sofort erkennbar.

JavaScript

function calc(a,b){if(a>0){return a+b}else{return a-b} }
Übersichtlich und mit sprechendem Namen
function calculate(a, b) {
  if (a > 0) {
    return a + b;
  } else {
    return a - b;
  }
}

Durch die Einrückungen wird klar, wann die Funktion beginnt und endet.

Solche Einrückungen entwickeln aber ihre größte Wirksamkeit, wenn die einzelnen Blöcke nicht zu groß sind. Wenn Code erst am rechten Bildschirmrand beginnt, ist die Hierarchietiefe zu komplex!

Empfehlung: Verwende sprechende Namen für Funktionen und Variablen.

Python

def process(items):
 for i in items:
  if i>10:print("Large");else:print("Small")
Eingerückt und übersichtlich
def process(items):
    for value in items:
        if value > 10:
            print("Large")
        else:
            print("Small")

Python ist extrem abhängig von Einrückung → gute Formatierung = Stabilität.

Fazit

Konsequente Formatierung wirkt auf den ersten Blick banal, ist aber ein zentraler Bestandteil professioneller Softwareentwicklung. Sie macht Code verständlich, vermeidet Fehler und spart langfristig enorm viel Zeit — für dich und jede Person, die deinen Code später liest.

Siehe auch

  • Einstieg in JavaScript
    • Erste Schritte
    • Programmieren und Debuggen
    • Funktionen
  • Guter HTML-Stil
    • Semantik - der Inhalt bestimmt die Struktur
    • Wie viel ARIA ist zuviel?
  • guter CSS-Stil
    • Regelsätze und Deklarationen
    • typische Fehlerquellen
    • CSS-Resets (Normalisierung)

Weblinks