Commentaires TypeScript en JSDoc
Convertissez les types de fonctions et d'interfaces TypeScript en commentaires JSDoc afin que les types survivent au JavaScript brut.
Commentaires TypeScript en JSDoc
Collez une fonction TypeScript, une fonction fléchée, une interface ou un alias de type et cet outil écrit le commentaire JSDoc correspondant au-dessus — `@param` pour chaque paramètre, `@returns` pour le type de retour, et `@typedef` avec lignes `@property` pour les interfaces et alias de type en forme d'objet. Il est conçu pour déplacer le code de `.ts` vers du JavaScript brut sans perdre les informations de type qu'un éditeur ou un linter conscient de JSDoc nécessite toujours.
"Supprimer les annotations TypeScript" supprime la syntaxe de type de la signature elle-même — types de paramètres, types de retour, listes de paramètres génériques — laissant du JavaScript valide avec les mêmes informations maintenant vivantes dans le commentaire; désactivez-le pour garder TypeScript tel quel et ajouter simplement de la documentation par-dessus. "Générer @typedef pour les interfaces" convertit une `interface` ou un `type` d'objet en bloc typedef; "Ajouter @template pour les génériques" documente les paramètres de type comme `<T>`; "Ajouter @throws depuis les throw" analyse le corps de chaque fonction pour `throw new SomeError(...)` et liste les types d'erreur distincts trouvés. Le style de commentaire bascule entre le bloc conventionnel d'astérisques alignés et une variante plus compacte d'ouverture monoligne, et la largeur de ligne contrôle où une longue ligne s'enroule.
L'outil lit les déclarations de fonction de niveau supérieur, les fonctions fléchées assignées à une `const` ou `let`, les interfaces et les alias de type en forme d'objet — les déclarations pour lesquelles JSDoc a une balise. Les annotations de type sur les variables locales dans un corps de fonction, et les méthodes définies dans une classe ou un littéral d'objet, sont laissées telles qu'elles sont écrites; réécrire chaque type dans un fichier en toute sécurité nécessite un compilateur complet, et cela reste un petit script rapide qui s'exécute au moment où vous arrêtez de taper.
Tout s'exécute localement dans votre navigateur — votre code ne s'envoie jamais, il est donc sûr de coller depuis un projet privé. Copiez le résultat, téléchargez-le en tant que fichier .txt, ou envoyez directement la sortie à l'entrée pour exécuter un autre outil sur elle ensuite.