Online JSDoc Generator

Zweck & Benutzerintention: Das Tool generiert JSDoc-Dokumentation aus JavaScript- und TypeScript-Quellen. Es liest Quellcodedateien, extrahiert dokumentierte Deklarationen und erzeugt eine strukturierte API-Referenz, geeignet für Bibliotheksautoren, SDK-Teams und Open-Source-Projekte. Es unterstützt TS-Typen, soweit vorhanden, und verbessert die Genauigkeit von Parameterbeschreibungen sowie das präzise Verlinken von Modulen und Symbolen.
Kernlogik & Funktionen: Das Tool nimmt Quellen auf, extrahiert JSDoc-Blöcke, löst Symbole auf und gibt in HTML, Markdown oder JSON aus. Es unterstützt Mehr-Datei-Projekte, Verzeichnisse und Repository-Eingaben. Erweiterte Optionen umfassen benutzerdefinierte Vorlagen, Modulgruppen, Sichtbarkeit privater Mitglieder, inkrementelle Generierung, TypeScript-Typinferenz und Post-Processing-Hooks für CI.
Eingaben & Ausgaben: Eingaben umfassen source_paths (String oder Array, Dateipfade oder Repo-URL), language (JS/TS), output_format (html, markdown, json), template (Name oder Inhalt), include_private (Boolean). Ausgaben umfassen docs_html, docs_markdown, docs_json sowie einen Modul-/Klassenindex und einen durchsuchbaren Index.
Algorithmen & Berechnungen: Es verwendet AST-Parsing, sammelt Symbole und JSDoc-Kommentare, ordnet Kommentare Deklarationen zu, grenzt Module ab und wendet Vorlagen an, um strukturierte Dokumentation zu erzeugen. Es validiert Eingabensyntax und überspringt nicht unterstützte Syntax, während Platzhalter für fehlende Kommentare erzeugt werden.
Fehler & Randfälle: Behandelt fehlende oder unvollständige JSDoc durch Warnungen in Logs und erzeugt Teil-Dokumentationen; skaliert große Codebasen im Streaming-Verfahren; liefert Default-Werte für nicht spezifizierte Optionen; warnt bei Repository-Zugriffsfehlern oder Rate-Limits.
Branche/Region & Lokalisierung: Verwendet gängige Code-Kommentar-Konventionen; Output-Vorlagen unterstützen lokalisierte Überschriften; keine Währungs- oder regionsspezifischen Daten; entspricht gängigen JS/TS-Dokumentationskonventionen.
Annahmen & Ausschlüsse: Geht davon aus, dass der Input zugänglicher Code ist und zum Parsen geeignet ist; schließt Live-Code-Ausführungsdokumentation, Runtime-Daten oder UI-Generierung aus; nicht verantwortlich für Hosting oder Rendering über die ausgewählten Ausgabeformate hinaus.