Online JSDoc Generator

Scopo & intento utente: lo strumento genera documentazione JSDoc dalle fonti JavaScript e TypeScript. Legge i file sorgente, estrae dichiarazioni documentate e produce un riferimento API strutturato, adatto ad autori di librerie, team SDK e progetti open source. Supporta i tipi TS quando presenti, migliorando l’accuratezza delle descrizioni dei parametri e permettendo un collegamento incrociato tra moduli e simboli.
Logica di base & caratteristiche: lo strumento acquisisce sorgenti, estrae blocchi JSDoc, risolve i simboli e produce output in HTML, Markdown o JSON. Supporta progetti multi-file, directory e input da repository. Opzioni avanzate includono modelli personalizzati, raggruppamento moduli, visibilità dei membri privati, generazione incrementale, inferenza dei tipi TypeScript e hook di post-processing per CI.
Ingressi & uscite: ingressi includono source_paths (stringa o array, percorsi o URL di repository), language (JS/TS), output_format (html, markdown, json), template (nome o contenuto), include_private (booleano). Uscite includono docs_html, docs_markdown, docs_json e un indice moduli/classi più un indice ricercabile.
Algoritmi & calcoli: usa parsing AST per raccogliere simboli e commenti JSDoc, assegna commenti alle dichiarazioni, delimita i confini del modulo e applica modelli per produrre documentazione strutturata. Validazione della sintassi e gestione di sintassi non supportate con placeholder per commenti mancanti.
Errori & casi limite: gestisce JSDoc mancanti o incompleti con avvisi, supporta grandi codebase tramite streaming; fornisce valori predefiniti per opzioni non specificate; avverte di errori di accesso ai repository o limiter di velocità.
Industria/Regione & Localizzazione: segue convenzioni di commenti in inglese americano; i modelli supportano intestazioni localizzate; nessun dato monetario o regionale; conforme alle convenzioni di documentazione JS/TS.
Assunzioni & Esclusioni: presuppone input accessibile e parsabile; esclude documentazione di esecuzione live, dati runtime o generazione UI; non si occupa di hosting o render oltre i formati di output selezionati.