8. API-Dokumentation erstellen
Geplanter Inhalt
Abschnitt betitelt „Geplanter Inhalt“- Vom Doku-Leser (1. Klasse) zum Doku-Schreiber: Wer liest meine Doku, und was braucht diese Person?
- JSDoc-Syntax:
@param,@returns, Typen, Kurzbeschreibung; Editor-Unterstützung in VS Code. - Was gehört in gute Methoden-Doku und was nicht (kein Nacherzählen des Codes).
- Doku als Vertrag: Vor- und Nachbedingungen informell festhalten.
- Generierte Doku ansehen (Hover in VS Code genügt; HTML-Generierung als Ausblick).
Lernziele
Abschnitt betitelt „Lernziele“- Funktionen und Klassen mit JSDoc vollständig dokumentieren.
- Aus der eigenen Doku heraus eine Funktion korrekt verwenden, ohne den Code zu lesen.
- Nützliche von überflüssiger Dokumentation unterscheiden.
Passende Übungen
Abschnitt betitelt „Passende Übungen“- Aufgabe 16 - Dokumentiere deine Bibliothek