Online JSDoc Generator

Syfte & användarintention: Verktyget generar JSDoc-dokumentation från JavaScript- och TypeScript-källor. Det läser källfiler, extraherar dokumenterade deklarationer och producerar en strukturerad API-Referens lämplig för biblioteksskapare, SDK-team och öppen källkodsprojekt. Det stöder TS-typer när de finns tillgängliga och förbättrar noggrannheten i parameterbeskrivningar samt möjliggör exakt korslänkning mellan moduler och symboler.
Kärnlogik & funktioner: Verktyget tar emot källor, extraherar JSDoc-block, upplöser symboler och outputar i HTML, Markdown eller JSON. Det stödjer flersidiga projekt, kataloger och repository-ingångar. Avancerade alternativ inkluderar anpassade mallar, module-gruppering, privat-medlemars synlighet, inkrementell generering, TypeScript-typinferens och post-processing-hooks för CI.
Inmatning & utdata: Inmatning inkluderar source_paths (sträng eller array, sökvägar eller repo-URL), språk (JS/TS), output_format (html, markdown, json), mall (namn eller innehåll), include_private (Boolean). Utdata inkluderar docs_html, docs_markdown, docs_json samt en modul-/klassindex och en sökbar index.
Algoritmer & beräkningar: Den använder AST-parsning för att samla symboler och JSDoc-kommentarer, kopplar kommentarer till deklarationer, avgränsar modulgränser och tillämpar mallar för att producera strukturerad dokumentation. Validerar syntax och hoppar över ej stöd sin syntax men genererar placeholders för saknade kommentarer.
Felsökning & kantfall: Hanterar saknade eller ofullständiga JSDoc med varningsloggar och genererar partiell dokumentation; klarar stora kodbaser via streambearbetning; tillhandahåller standardinställningar för ospecificerade alternativ; varnar för fel vid åtkomst till repository eller hastighetsbegränsningar.
Bransch/Region & Lokalisering: Följer vanliga JavaScript/TypeScript-dokumentationskonventioner; mallar stöder lokala rubriker; inga valuta- eller regionala data; följer standarder för dokumentation.
Antaganden & undantag: Anta att indata är tillgänglig kod som går att analysera; utesluter live-kodkörning, runtime-data eller UI-generering; ansvarar inte för hosting eller rendering utöver valda utdataformat.