Comentarii TypeScript la JSDoc
Transformă tipurile de funcții și interfețe TypeScript în comentarii JSDoc, así încât tipurile să supraviețuiască în JavaScript simplu.
Comentarii TypeScript la JSDoc
Lipește o funcție TypeScript, funcție cu săgeată, interfață sau alias de tip și acest instrument scrie comentariul JSDoc corespunzător deasupra — `@param` pentru fiecare parametru, `@returns` pentru tipul de întoarcere, și `@typedef` cu linii `@property` pentru interfețe și aliasuri de tip cu formă de obiect. A fost construit pentru a muta codul de la `.ts` la `.js` simplu fără a pierde informațiile de tip pe care un editor sau linter conștient de JSDoc le mai are nevoie.
Elimina anotațiile TypeScript elimină sintaxa tipului din semnătura în sine — tipuri de parametri, tipuri de întoarcere, liste de parametri generici — lăsând JavaScript valid cu aceleași informații acum în comentariu; dezactivează-o pentru a păstra TypeScript neschimbat și doar adaugă documentație deasupra. Generează @typedef pentru interfețe transformă o `interface` sau un `type` de obiect într-un bloc typedef; Adaugă @template pentru genérice documentează parametrii de tip precum `<T>`; Adaugă @throws din instrucțiuni throw scanează fiecare corp de funcție pentru `throw new SomeError(...)` și listează tipurile de eroare distincte găsite. Stilul de comentariu alternează între blocul cu stele aliniate convențional și o variantă mai compactă cu deschidere pe o linie, iar lățimea liniei controlează unde o linie lungă se întrerupe.
Instrumentul citește declarații de funcție de nivel superior, funcții cu săgeată atribuite unei `const` sau `let`, interfețe și aliasuri de tip cu formă de obiect — declarațiile pentru care JSDoc are o etichetă. Anotațiile de tip pe variabilele locale din interiorul unui corp de funcție, și metodele definite în interiorul unei clase sau a unui literal de obiect, sunt lăsate așa cum au fost scrise; rescrierea în siguranță a fiecărui tip dintr-un fișier necesită un compilator complet, și aceasta rămâne un script mic și rapid care funcționează în momentul în care te oprești din scris.
Tot se execută local în browserul tău — codul tău nu este niciodată încărcat, deci lipirea din proiectele private este sigură. Copiază rezultatul, descarcă-l ca fișier .txt sau trimite rezultatul direct înapoi la intrare pentru a rula un alt instrument pe el mai departe.