Codeelemente formatieren
Version: 2.0 · Stand: 2026-07-04 · Struktureller Bezug: Microsoft Writing Style Guide – Formatting developer text elements (CC BY 4.0)
Programmatische Elemente werden im Code-Stil dargestellt (in DokuWiki: ''…'' oder Codeblock). Die Groß-/Kleinschreibung folgt dem Code – nicht der deutschen Rechtschreibung. Was im Code klein ist, bleibt klein; Norm- und Produktnamen behalten ihre Eigenschreibweise.
Siehe auch Groß- und Kleinschreibung · Text in Anleitungen formatieren
| Element | Konvention | Beispiel |
|---|---|---|
| Klassen, Methoden, Eigenschaften, Felder | Code-Stil, Schreibweise wie im Code. | SymmetricEncryptionExtensions, Encrypt(), KeyLength |
| Parameter, Variablen, Konstanten | Code-Stil. | keyId, INT_MAX |
| Datentypen, Schlüsselwörter | Code-Stil, wie in der Sprache. | byte[], void, true |
| Kommandozeilenbefehle und -optionen | Code-Stil, Schreibweise wie einzugeben. | openssl req, -newkey |
| Dateinamen, Pfade, Erweiterungen | Code-Stil; Erweiterungen klein. | konfiguration.yaml, C:\WvdS\keys, .pfx |
| Umgebungsvariablen | Code-Stil. | OPENSSL_PATH, GATEWAY_ROOT |
| Markup-/XML-Elemente (Tags) | Code-Stil, meist in spitzen Klammern. | <configuration> |
| Registry-/Config-Schlüssel | Code-Stil. | HKEY_LOCAL_MACHINE |
| Fehlermeldungen | Normale deutsche Schreibung; im Text in Anführungszeichen „…“. | „Zertifikat konnte nicht geprüft werden“ |
| Platzhalter | Kursiv (UI) bzw. spitze Klammern (Code). | Geben Sie Kennwort ein · –out <dateiname> |
| Neue Fachbegriffe | Kursiv bei erster, erklärter Nennung. | Ein Nonce ist ein einmalig verwendeter Zufallswert. |
| Produkte, Bibliotheken, Normen | Eigenschreibweise. | Data Gateway, OpenSSL, ML-KEM, TLS 1.3 |
| URLs | Klein; Umbruch vor Schrägstrich; Code-Stil in Code. | www.thewhiteknightlabs.de |
Hinweis Lokalisierung mitdenken: Code-Bezeichner werden nicht übersetzt; nur der erklärende Text um sie herum. Deutsche Umlaute und die Zeichen der Zielsprachen erfordern UTF-8 (siehe Web, Software und Zeichenkodierung).
Redaktionsleitfaden von The White Knight Labs. Aufbau nach dem Microsoft Writing Style Guide (© Microsoft Corporation, CC BY 4.0); Inhalte für den deutschsprachigen Raum eigenständig erarbeitet. Sprachregeln nach amtlicher deutscher Rechtschreibung, Duden und DIN 5008.