Funktionsweise

Liest eine Codedatei oder Funktion ein und liefert eine präzise Erklärung ihres Zwecks, der Hauptlogik, der Abhängigkeiten und wichtiger Nebeneffekte. Die Zusammenfassung hilft Entwicklern, unbekannten Code zu verstehen, ersetzt jedoch nicht die direkte Überprüfung oder das Testen.

So funktioniert es

Geben Sie den Code, die Programmiersprache, den relevanten Repository-Kontext und die Zielgruppe für die Zusammenfassung an. Bitten Sie um eine Schwerpunktsetzung auf Bereiche wie öffentliche Schnittstellen, Datenfluss, Fehlerbehandlung oder bekannte Risiken. Ein Entwickler sollte das Ergebnis mit der Quelle abgleichen, bevor es als Dokumentation verwendet wird.

Beispiel-Workflows

• Geänderten Code für einen Pull-Request-Review zusammenfassen.

• Onboarding-Notizen für einen unbekannten Dienst oder ein Modul erstellen.

• Entwurf einer Referenzdokumentation aus ausgewählten Funktionen und Schnittstellen erstellen.