Ga naar inhoud
100% lokaal

TypeScript naar JSDoc-opmerkingen

Zet TypeScript-functie- en interfacetypen om in JSDoc-opmerkingen, zodat typen in platte JavaScript behouden blijven.

Invoer
Uitvoer

TypeScript naar JSDoc-opmerkingen

Voeg een TypeScript-functie, pijlfunctie, interface of type-alias in, en dit hulpmiddel schrijft de bijbehorende JSDoc-opmerking erboven — `@param` voor elke parameter, `@returns` voor het retourtype en `@typedef` met `@property`-regels voor object-gevormd interfaces en type-aliassen. Het is gebouwd voor het verplaatsen van code van `.ts` naar platte `.js` zonder de type-informatie te verliezen die een editor of een JSDoc-bewuste linter nog steeds nodig heeft.

"TypeScript-aantekeningen verwijderen" verwijdert de typsyntaxis uit de handtekening zelf — parametertypen, retourtypen, generieke parameterlisten — laat geldige JavaScript achter met dezelfde informatie nu in de opmerking. Zet deze optie uit om TypeScript ongewijzigd te houden en voeg alleen documentatie bovenop toe. "@typedef voor interfaces genereren" zet een `interface` of een object-gevormd `type` in een typedef-blok om. "@template voor generics toevoegen" documenteert typeparameters zoals `<T>`; "@throws uit throw-statements toevoegen" scant het functie-lichaam naar `throw new SomeError(...)` en vermeldt de verschillende gevonden fouttypen. Commentaarstijl schakelt tussen het conventionele blok met uitgelijnde sterretjes en een compactere one-line-open variant, en regellengte bepaalt waar een lange regel wordt afgebroken.

Het hulpmiddel leest functie-declaraties op het hoogste niveau, pijlfuncties toegewezen aan een `const` of `let`, interfaces en object-gevormde type-aliassen — de declaraties waarvoor JSDoc een tag heeft. Type-aantekeningen op lokale variabelen in het functie-lichaam en methoden die in een klasse of object-letterlijk zijn gedefinieerd, blijven onveranderd. Het veilig herschrijven van alle typen in een bestand vereist een volledige compiler, en dit blijft een klein, snel script dat draait op het moment dat u stopt met typen.

Alles draait lokaal in uw browser — uw code wordt nooit geüpload, dus het plakken uit een privéproject is veilig. Kopieer het resultaat, download het als .txt-bestand, of stuur de uitvoer direct terug naar de invoer om een ander hulpmiddel erop uit te voeren.

FAQ

Werkt het ook op interfaces en niet alleen functies?
Ja. Interfaces en object-gevormde type-aliassen worden een @typedef-blok met één @property-regel per lid; een union of primitief type-alias wordt in plaats daarvan een @typedef met één regel.
Wat gebeurt er met de originele TypeScript-typen?
Als "TypeScript-aantekeningen verwijderen" ingeschakeld is, wordt de typsyntaxis uit de code verwijderd en bestaat alleen nog in de opmerking erboven, waardoor platte JavaScript achterblijft. Schakel de optie uit om TypeScript als zodanig te behouden en voeg JSDoc erbovenop toe.
Documenteert het methoden in een klasse?
Nee. Het hulpmiddel documenteert functie-declaraties op het hoogste niveau, pijlfuncties toegewezen aan een `const` of `let`, interfaces en type-aliassen. Methoden die in een klasse of object-letterlijk zijn gedefinieerd, blijven onveranderd.
Waar komen de @throws-tags vandaan?
Het hulpmiddel scant het functie-lichaam naar throw-statements. Een `throw new SomeError(...)` wordt gerapporteerd als `@throws {SomeError}`; een bare throw wordt gerapporteerd als `@throws {Error}`.
Wordt mijn code ergens geüpload?
Nee. De conversie draait volledig in uw browser — uw code verlaat uw apparaat nooit.