TypeScript v JSDoc komentarje
Pretvori tipe funkcij TypeScript in vmesnikov v komentarje JSDoc, tako da se tipi ohranijo v navadnem JavaScriptu.
TypeScript v JSDoc komentarje
Prilepite TypeScript funkcijo, arrow funkcijo, vmesnik ali alias tipa in to orodje napiše ustrezen JSDoc komentar nad njim — `@param` za vsak parameter, `@returns` za tip vrnjene vrednosti, in `@typedef` z `@property` vrsticami za vmesnike in type aliase oblike objekta. Ustvarjen je za premikanje kode iz `.ts` v navaden `.js` brez izgube informacij o tipih, ki jih urejevalnik ali JSDoc-ozavesten linter še vedno potrebuje.
"Odstrani TypeScript anotacije" odstrani tip sintakso iz samega podpisa — tipih parametrov, povratne tipe, sezname generičnih parametrov — pri čemer ostane veljaven JavaScript z istimi informacijami, ki sedaj živijo v komentarju; izklopite ga, da obdržite TypeScript nespremenjen in preprosto dodate dokumentacijo na vrh. "Generiraj @typedef za vmesnike" pretvori `interface` ali tip objekta `type` v blok typedef; "Dodaj @template za generike" dokumentira tipske parametre, kot so `<T>`; "Dodaj @throws iz throw izjav" skenira telo vsake funkcije za `throw new SomeError(...)` in navede različne najdene tipe napak. Slog komentarja se preklopi med konvencionalnim blokom z poravnanimi zvezami in kompaktnejšo one-line-open varianto, širina linije pa nadzoruje, kje se dolga vrstica prelomi.
Orodje bere deklaracije funkcij na vrhu nivoja, arrow funkcije dodeljene `const` ali `let`, vmesnike in type aliase oblike objekta — deklaracije, za katere ima JSDoc oznako. Anotacije tipa na lokalnih spremenljivkah znotraj telesa funkcije in metode, definirane znotraj razreda ali objektnega dobesednika, ostanejo tako kot so napisane; prepis vseh tipih v datoteki varno potrebuje polni kompajler, in to ostane malo, hitro skripto, ki se zažene, ko nehate tipkati.
Vse se izvršuje lokalno v vašem brskalniku — vaša koda se nikoli ne nakaže, zato je lepljenje kode iz zasebnega projekta varno. Kopirajte rezultat, preuzmite ga kot .txt datoteko, ali pošljite izhod direktno nazaj v vhod, da ga zaženete z drugim orodjem.