TypeScript JSDoc megjegyzésekké
Alakítsa át TypeScript függvény- és interfész típusokat JSDoc megjegyzésekké, hogy a típusok tiszta JavaScript-ben is megmaradjanak.
TypeScript JSDoc megjegyzésekké
Adjon meg egy TypeScript függvényt, nyíl függvényt, interfészt vagy típus aliast, és az eszköz az azzal egyező JSDoc megjegyzést írja fölé — `@param` minden paraméterhez, `@returns` a visszatérési típushoz, és `@typedef` a `@property` sorokkal az objektum alakú interfészekhez és típus aliasokhoz. Arra szolgál, hogy kódot helyezzen át `.ts`-ből sima `.js`-be anélkül, hogy elveszítené az típusadatokat, amelyekre a szerkesztő vagy egy JSDoc-kompatibilis linter még szüksége van.
A "TypeScript típusok eltávolítása" opció eltávolítja a típus szintaxist magából az aláírásból — paraméter típusok, visszatérési típusok, általános paraméter listák — így érvényes JavaScript marad, ahol ugyanaz az információ most a megjegyzésben él; kapcsolja ki, ha meg szeretné tartani a TypeScript-et, és csak dokumentáció helyezzen fölé. A "@typedef generálása interfészekből" egy `interface` vagy objektum `type` typedef blokkká alakít; az "@template hozzáadása általános típusokhoz" dokumentálja a típus paramétereket, mint a `<T>`; a "@throws hozzáadása throw utasításokból" megvizsgálja az egyes függvénytörzset a `throw new SomeError(...)` kifejezésekhez, és felsorolja a talált különálló hibatype-okat. A megjegyzés stílusa a szokásos, csillagokkal igazított blokk és a szűkebb egy-sor-nyitott változat között választ, a sor szélessége pedig azt szabályozza, hol törik meg egy hosszú sor.
Az eszköz felső szintű függvénydefiníciókat, nyíl függvényeket, amelyek egy `const` vagy `let` értékhez vannak rendelve, interfészeket és objektum alakú típus aliasokat olvas — azokat a deklarációkat, amelyekhez a JSDoc-nak címkéje van. Típusanotációk a függvénytörzs belsejében lévő helyi változókon, valamint egy osztályon belül vagy objektum literálban definiált metódusokon maradnak az írott formában; a fájl minden típusának biztonságos átírásához teljes fordítóra van szükség, és ez egy kis, gyors szkript marad, amely a beírás pillanatában fut.
Minden helyileg fut a böngészőjében — kódja soha nem kerül feltöltésre, ezért a magánprojektből való beillesztés biztonságos. Másolja ki az eredményt, töltse le .txt fájlként, vagy küldje az outputot közvetlenül vissza az inputba, hogy a következő eszközt futtassa rajta.