Technische Dokumentation generieren
Verwenden Sie KI, um Kommentare, JSDoc-Blöcke oder andere Formen technischer Dokumentation für Ihren Code zu erstellen. Dies verbessert die Verständlichkeit und Wartbarkeit des Codes.
Originalvideo ansehen: OpenAI just killed SORA3 Schritte
1
Wählen Sie den zu dokumentierenden Code
Kopieren Sie die Funktion, Klasse oder das Modul, für das Sie Dokumentation generieren möchten.
Tipp: Konzentrieren Sie sich auf öffentliche Schnittstellen oder komplexe Logik, die eine gute Dokumentation erfordert.
2
Formulieren Sie den Prompt
Fügen Sie den Code in das LLM ein und bitten Sie es, Dokumentation in einem bestimmten Format zu erstellen (z.B. 'Schreibe JSDoc-Kommentare für diese Funktion', 'Erstelle eine kurze Erklärung für dieses Modul').
Schreibe JSDoc-Kommentare für die folgende JavaScript-Funktion:
```javascript
function calculateDiscount(price, discountPercentage) {
if (discountPercentage < 0 || discountPercentage > 100) {
throw new Error('Invalid discount percentage');
}
return price * (1 - discountPercentage / 100);
}
```3
Überprüfen und Anpassen
Fügen Sie die generierte Dokumentation in Ihren Code ein. Überprüfen Sie sie auf Genauigkeit, Vollständigkeit und Stil. Passen Sie sie bei Bedarf an, um sicherzustellen, dass sie den Zweck des Codes korrekt widerspiegelt.
Warnung: KI kann manchmal Annahmen treffen, die nicht korrekt sind, oder wichtige Details übersehen. Immer manuell überprüfen.