Code

Verwendet in normalen Textsätzen (im Gegensatz zu z.B. Codebeispielen) eine nicht-proportionale Schriftart, um Code auszuzeichnen.

  • verwendet in HTML das <code>-Element.

  • in Markdown einen Backtick ` vor und nach dem Code

  • in reStructuredText zwei Backticks `` davor und danach

Diese Seite erklärt, wie ihr Code in normalen Textsätzen formatiert.

Einige spezifische Code-Elemente

Die folgende Liste enthält Elemente, die als Code dargestellt werden sollten; sie ist jedoch nicht vollständig.

  • Attributnamen und -werte

  • Klassennamen

  • Datentypen

  • Konstanten

  • Namen von Umgebungsvariablen

  • Schlüsselwörter der Programmiersprache

  • Methoden- und Funktionsnamen

  • Namespace-Aliase

  • Namen von Befehlszeilenprogrammen

  • Elementnamen (XML und HTML)

    Setzt spitze Klammern (<>) um den Elementnamen.

  • HTTP-Statuscodes und -Content-Types

  • DNS Record-Typen

  • Dateinamen, Dateinamenerweiterungen (falls verwendet) und Pfade

  • Ordner und Verzeichnisse

Bemerkung

Generell solltet ihr keinen Code in Anführungszeichen setzen, es sei denn, die Anführungszeichen sind Teil des Codes.

Sprachunterstützung in Sphinx

Sphinx unterstützt verschiedene Sprachen, u.a.

Siehe auch

Elemente, die normal dargestellt werden sollen

Die folgende Liste enthält Elemente, die nicht als Code dargestellt werden sollten; die Liste ist jedoch nicht vollständig.

  • E-Mail-Adressen

  • Namen von Produkten, Dienstleistungen und Organisationen

    Oft werden die Namen von Befehlszeilen-Dienstprogrammen genauso geschrieben wie das Software-Projekt oder -Produkt, mit dem sie verbunden sind. Verwendet in solchen Fällen Code für den Befehl und die normale Schrift für den Namen des Projekts oder Produkts.

    Beispiel: Ruft den GCC-Compiler mit gcc auf.

  • URLs

    Siehe auch