Dokumentation mit ChatGPT generieren
Lasse ChatGPT automatisch Kommentare, JSDoc-Blöcke oder README-Dateien für deinen Code erstellen, um die Dokumentation zu verbessern.
Originalvideo ansehen: KI-Agenten: DAS übersehen gerade ALLE! Claude Updates, Googl...4 Schritte
1
Code-Abschnitt auswählen
Wähle den Code-Abschnitt (Funktion, Klasse, Modul), für den du Dokumentation generieren möchtest.
2
Prompt formulieren
Gib ChatGPT einen klaren Auftrag, welche Art von Dokumentation du benötigst. Beispiele: 'Generiere JSDoc-Kommentare für diese Funktion.', 'Schreibe eine README-Datei für dieses Projekt basierend auf dem folgenden Code.', 'Erkläre diesen Code und füge Inline-Kommentare hinzu.'
3
Code einfügen
Füge den Code, der dokumentiert werden soll, in den Chat ein.
```
[Dein Code hier]
```4
Dokumentation prüfen und anpassen
Überprüfe die generierte Dokumentation auf Genauigkeit, Vollständigkeit und Stil. Passe sie bei Bedarf an die spezifischen Anforderungen deines Projekts an.
Tipp: Gib ChatGPT zusätzliche Informationen über den Zweck des Codes oder die erwarteten Parameter, um präzisere Dokumentation zu erhalten.