Codeblöcke

Codeblöcke sind Abschnitte eines Textdokuments, die Quellcode enthalten. Sie unterscheiden sich von dem Fließtext durch feste Einrückung, spezielle Markierungen oder andere Formatierungen, die die Zeichenfolge als Programmcode kennzeichnen. Ziel ist es, die Lesbarkeit zu erhöhen, die Struktur des Codes zu bewahren und das Kopieren des Codes zu erleichtern. Zudem ermöglichen Codeblöcke häufig eine Syntax-Hervorhebung, die Schlüsselwörter, Zeichenfolgen und Kommentare farblich kennzeichnet.

Es gibt verschiedene Arten von Codeblöcken. Inline-Codespannen erscheinen innerhalb eines Satzes und verwenden in vielen Systemen geringfügige Markierungen, um kurze Code-Schnipsel hervorzuheben. Mehrzeilige Codeblöcke dienen dazu, größeren Quelltext darzustellen. In Markdown, reStructuredText und ähnlichen Sprachen werden Codeblöcke oft durch eingerückte Abschnitte oder durch spezielle Marker (Fenced Blocks) abgegrenzt; häufig lässt sich eine Programmiersprache für die Hervorhebung angeben.

In Wikis und Dokumentationsplattformen werden Codeblöcke genutzt, um Codeschnipsel verständlich zu präsentieren. Viele Systeme unterstützen zusätzlich eine Syntax-Hervorhebung, was die Lesbarkeit weiter erhöht. Die Blöcke bewahren Leerzeichen und Zeilenumbrüche, weshalb sie sich auch für Sprachen mit einrückungsbasierter Syntax, wie Python, eignen.

Best practices: Codeblöcke sollten aussagekräftige, relevante Ausschnitte enthalten, überflüssigen Code vermeiden, korrekt eingerückt sein und, wenn möglich, mit Kommentaren versehen werden. Bei längeren Beispielen empfiehlt es sich, Kontext bereitzustellen oder auf externe Dateien zu verweisen.