CodeBlock

Der CodeBlock dient der übersichtlichen Darstellung von Code als Block mit Syntax-Highlighting.GitHubMarkdown

Grundlagen

Best practices

Achte bei der Verwendung vom CodeBlock darauf, dass ...

  • er nur genutzt wird, wenn der Inhalt länger als eine Zeile ist.
  • bei langen Inhalten Zeilennummern verwendet werden, um die Orientierung zu verbessern.
  • der Inhalt nur dann kopierbar ist, wenn er sinnvoll an anderer Stelle weiterverwendet werden kann.

Verwendung

Verwende den CodeBlock, um ...

  • Code-Beispiele übersichtlich und mit dem richtigen Syntax-Highlighting darzustellen.
  • dem User eine einfache Möglichkeit zu bieten, Code-Snippets zu kopieren.
  • umfangreiche Error-Logs übersichtlich anzuzeigen.

Auf dieser Seite