Dokumentationsgenerierung für Code mit ChatGPT
Lasse ChatGPT Code-Dokumentation (z.B. Docstrings, Kommentare) basierend auf deinem Code und dessen Funktionalität erstellen. Dies verbessert die Verständlichkeit und Wartbarkeit.
Originalvideo ansehen: KI am MURKSEN hindern!3 Schritte
1
Gib den zu dokumentierenden Code an.
Füge den Code-Abschnitt ein, für den du Dokumentation benötigst.
2
Fordere Dokumentation an.
Bitte ChatGPT, Docstrings oder Kommentare zu generieren, die die Funktion, Parameter, Rückgabewerte und mögliche Fehler erklären.
Erstelle einen Docstring für diese Python-Funktion, der ihre Aufgabe, Parameter und Rückgabewerte beschreibt:
```python
[Deine Funktion hier]
```3
Überprüfe und integriere die Dokumentation.
Lies die generierte Dokumentation durch und passe sie an, um Genauigkeit und Klarheit zu gewährleisten. Füge sie dann in deinen Code ein.