Codebeispiele
Version: 2.0 · Stand: 2026-07-04 · Struktureller Bezug: Microsoft Writing Style Guide – Code examples (CC BY 4.0)
Codebeispiele zeigen, wie ein Programmierelement eine konkrete Aufgabe löst. Viele Entwickelnde übernehmen Beispielcode direkt – deshalb muss er korrekt, sicher und übertragbar sein.
Planen
- Für die Zielgruppe relevante Aufgaben zeigen; einfach beginnen, dann steigern.
- Häufige und knifflige Elemente priorisieren; keine Beispiele für Offensichtliches.
- Eine kurze Einleitung beschreibt das Szenario und nennt Voraussetzungen und Abhängigkeiten.
- Code leicht kopier- und ausführbar halten; SEO über Verlinkung (siehe Schreiben für die Suche).
Schreiben
- Sicherheit zuerst – gerade in der Fachdomäne von The White Knight Labs: Eingaben validieren, keine Geheimnisse (Schlüssel, Passwörter, Tokens) im Code hinterlegen, Schwachstellen mit Analysewerkzeugen prüfen.
- Kenntlich machen, was angepasst werden muss (Platzhalter); Kommentare erklären das Warum, nicht Offensichtliches.
- Die erwartete Ausgabe zeigen (eigener Abschnitt oder Kommentar).
- Barrierefreiheit bei UI-erzeugendem Code beachten (Alternativtexte).
- Ausnahmebehandlung nur zeigen, wenn sie zum Beispiel gehört.
- Code immer kompilieren und testen.
Beispiel (Hinweis auf Platzhalter und Sicherheit)
// Schlüssel NIE im Code hinterlegen – aus sicherem Speicher laden:
var key = keyStore.Load("<schluessel-id>");
var cipher = plaintext.Encrypt(key); // ML-KEM/AES nach Konfiguration
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.
de/wiki/help/style-guide/developer-content/code-examples.txt · Zuletzt geändert: von 127.0.0.1