Online JSDoc Generator

Formål & brukerintensjon: Verktøyet genererer JSDoc-dokumentasjon fra JavaScript- og TypeScript-kilder. Det leser kildefiler, ekstraherer dokumenterte deklarasjoner og produserer en strukturert API-referanse egnet for bibliotikkforfattere, SDK-team og åpne kilde-prosjekter. Det støtter TS-typer når tilgjengelig, og forbedrer nøyaktigheten i parameterbeskrivelser og kobling mellom moduler og symboler.
Kjernelogikk & funksjoner: Verktøyet tar imot kilder, ekstraherer JSDoc-blokker, løser symboler og produserer HTML, Markdown eller JSON. Det støtter flerfil-prosjekter, mapper og repository-innspill. Avanserte alternativer inkluderer tilpassede maler, modulgruppering, synlighet for private medlemmer, inkrementell generering, TypeScript-typeinferanse og post-processor-hooks for CI.
Inndata & utdata: Inndata inkluderer source_paths (streng eller array, stier eller repo-URL), språk (JS/TS), output_format (html, markdown, json), mal (navn eller innhold), include_private (bool). Utdata inkluderer docs_html, docs_markdown, docs_json samt en modul-/klasseindeks og en søkbar indeks.
Algoritmer & beregninger: Den bruker AST-parsing for å samle symboler og JSDoc-kommentarer, koble kommentarer til deklarasjoner, avgrense module-grenser og anvende maler for å produsere strukturert dokumentasjon. Validering av syntaks og håndtering av ikke-støttede syntakser med plassholdere for manglende kommentarer.
Feil & kanttilfeller: Håndterer manglende eller ufullstendige JSDoc med varslingslogger og genererer delvis dokumentasjon; håndterer store kodebaser via streaming; gir standardinnstillinger for ikke-spesifiserte alternativer; varsler ved tilgangsfeil til depot eller hastighetsbegrensninger.
Bransje/Region & Lokalisering: Følger vanlige JavaScript/TypeScript-dokumentasjonskonvensjoner; maler støtter lokaliserte overskrifter; ingen valuta- eller regiondata; følger vanlige dokumentasjonskonvensjoner.
Antagelser & Unntak: Forutsetter at inndata er tilgjengelig kode som kan parses; utelukker kjøring av kode i sanntid, kjøretidsdata eller UI-generering; ikke ansvarlig for hosting eller rendering utover valgte utdataformater.