Commenti da TypeScript a JSDoc
Converti i tipi di funzioni e interfacce TypeScript in commenti JSDoc in modo che i tipi sopravvivano al JavaScript semplice.
Commenti da TypeScript a JSDoc
Incolla una funzione TypeScript, una funzione freccia, un'interfaccia o un alias di tipo e questo strumento scrive il commento JSDoc corrispondente sopra — `@param` per ogni parametro, `@returns` per il tipo di ritorno, e `@typedef` con righe `@property` per interfacce e alias di tipo a forma di oggetto. È costruito per spostare codice da `.ts` a JavaScript semplice senza perdere le informazioni di tipo che un editor o un linter consapevole di JSDoc ha ancora bisogno.
"Rimuovere annotazioni TypeScript" elimina la sintassi del tipo dalla firma stessa — tipi di parametri, tipi di ritorno, elenchi di parametri generici — lasciando JavaScript valido con le stesse informazioni ora viventi nel commento; disattivalo per mantenere TypeScript intatto e semplicemente aggiungere documentazione sopra. "Generare @typedef per le interfacce" converte un'`interface` o un `type` di oggetto in un blocco typedef; "Aggiungere @template per i generici" documenta i parametri di tipo come `<T>`; "Aggiungere @throws dalle throw" scansiona il corpo di ogni funzione per `throw new SomeError(...)` ed elenca i tipi di errore distinti trovati. Lo stile di commento passa dal blocco convenzionale di asterischi allineati a una variante più compatta di apertura su una sola riga, e la larghezza della riga controlla dove una riga lunga va a capo.
Lo strumento legge le dichiarazioni di funzione di livello superiore, le funzioni freccia assegnate a una `const` o `let`, le interfacce e gli alias di tipo a forma di oggetto — le dichiarazioni per le quali JSDoc ha un tag. Le annotazioni di tipo su variabili locali dentro un corpo di funzione, e i metodi definiti dentro una classe o un letterale di oggetto, vengono lasciati così come sono scritti; riscrivere ogni tipo in un file in modo sicuro ha bisogno di un compilatore completo, e questo rimane uno script piccolo e veloce che viene eseguito quando smetti di digitare.
Tutto viene eseguito localmente nel tuo browser — il tuo codice non viene mai caricato, quindi incollare da un progetto privato è sicuro. Copia il risultato, scaricalo come file .txt, o invia l'output direttamente all'input per eseguire un altro strumento su di esso dopo.