Code-Dokumentation generieren
Erstellen Sie automatisch hochwertige Dokumentation für Ihre Codebasis.
Prompt-Vorlage
Erstelle eine vollständige Dokumentation für den folgenden [PROGRAMMIERSPRACHE]-Code: **Dokumentations-Anforderungen:** - Format: [JSDoc/Docstring/XML-Doc/Markdown] - Zielgruppe: [Entwickler im Team/externe API-Nutzer/Open-Source-Community] - Stil: [STIL DER DOKUMENTATION] **Bitte erstelle für jede Funktion/Klasse/Modul:** 1. **Beschreibung:** Was macht die Einheit und warum existiert sie? 2. **Parameter:** Typen, Beschreibungen, Standardwerte, Constraints 3. **Rückgabewerte:** Typ, Beschreibung, mögliche Werte 4. **Exceptions:** Welche Fehler können auftreten und wann? 5. **Beispiele:** Mindestens ein Verwendungsbeispiel mit Ein- und Ausgabe 6. **Hinweise:** Performance-Implikationen, Thread-Safety, Deprecation **Zusätzliche Dokumentation:** - Modul-Übersicht mit Abhängigkeitsdiagramm - Getting Started Guide für neue Entwickler - Architektur-Entscheidungen (ADRs) - FAQ zu häufigen Fragen Code: ```[PROGRAMMIERSPRACHE] [CODE HIER EINFÜGEN] ```
Platzhalter in [eckigen Klammern] ersetzen: [PROGRAMMIERSPRACHE][JSDoc/Docstring/XML-Doc/Markdown][Entwickler im Team/externe API-Nutzer/Open-Source-Community][STIL DER DOKUMENTATION][CODE HIER EINFÜGEN]
So verwendest du die Vorlage
Kopiere den Prompt, ersetze die Platzhalter in eckigen Klammern durch deine Angaben und füge ihn in den KI-Assistenten deiner Wahl ein. Je genauer die Angaben, desto besser das Ergebnis.
Tipps für bessere Ergebnisse
- Geben Sie die Zielgruppe der Dokumentation an
- Erwähnen Sie das gewünschte Dokumentationsformat
- Fragen Sie nach einem Architecture Decision Record (ADR)
- Bitten Sie um Diagramme in Mermaid-Syntax
Passende offene Modelle
Die Auswahl nennt aktuelle offene Modelle als Ausgangspunkt für eigene Tests. Sie ist keine Messung für diese Vorlage.
Stichwörter: #documentation #jsdoc #comments #knowledge-sharing