Code dokumentieren

Für Docstrings, README-Abschnitte oder Kommentare. Das Modell erklärt, was der Code tut, nicht wie jede Zeile funktioniert.

Ihre AngabenProgrammieren

Ihre Eingaben bleiben bis zum Schließen des Tabs erhalten und verlassen Ihr Gerät nicht. Leere Felder bleiben als [Platzhalter] stehen und lassen sich im Chat ergänzen.

Fertiger Prompt
Öffnen inChatGPTClaude

Tipps
  • Stil-Beispiele: „Google-Docstrings“, „JSDoc“, „Javadoc“.
Wortlaut

Der Prompt zum Kopieren

Die Vorlage im Wortlaut. Teile in doppelten geschweiften Klammern sind Platzhalter, die das Formular oben für Sie ersetzt.

Schreibe Dokumentation für den folgenden {{Programmiersprache}}-Code im Stil {{Dokumentationsstil}}. Beschreibe Zweck, Parameter, Rückgabewert, Ausnahmen und ein kurzes Anwendungsbeispiel. Kommentiere im Code nur Stellen, deren Absicht nicht offensichtlich ist. Ändere den Code selbst nicht.

Code:
{{Code}}

Wann die Vorlage hilft

Für Entwicklerinnen, die Funktionen, Klassen oder Module nachträglich dokumentieren wollen, etwa vor einer Übergabe, für eine Open-Source-Veröffentlichung oder für neue Teammitglieder. Die Vorlage erzeugt Docstrings und kurze Beispiele im gewünschten Stil, ohne den Code selbst zu verändern.

Beispiel

Programmiersprache: TypeScript; Dokumentationsstil: JSDoc; Code: eine Funktion, die Bruttopreise aus Nettopreisen berechnet und bei negativen Werten einen Fehler wirft. Sie erhalten einen JSDoc-Block mit Beschreibung, Angaben zu Parametern und Rückgabewert, einem Hinweis auf den Fehler bei negativen Werten und einem kurzen Aufrufbeispiel.

Varianten

  • Einen README-Abschnitt mit Installation und Verwendung für ein ganzes Modul schreiben lassen.
  • Bestehende Kommentare auf Aktualität prüfen lassen, wenn sich der Code geändert hat.
  • Die Dokumentation auf Englisch für ein internationales Team erstellen lassen.

Passende Ratgeber

Programmieren

Weitere Vorlagen

Alle 64 Vorlagen
Fragen

Häufige Fragen zur Vorlage

Welche Kommentare gehören in den Code und welche nicht?

Sinnvoll sind Kommentare, die erklären, warum etwas so gelöst ist, und die Dokumentation öffentlicher Schnittstellen. Kommentare, die nur wiederholen, was eine Zeile offensichtlich tut, veralten schnell und stören beim Lesen.

Kann KI Dokumentation automatisch aktuell halten?

Code-Assistenten können Dokumentation bei Änderungen mit anpassen, wenn man sie darum bittet. Eine Prüfung im Review bleibt nötig, weil abweichende Beschreibungen sonst unbemerkt bleiben.