Documenter du code avec JSDoc/TSDoc
Générez une documentation JSDoc/TSDoc professionnelle et complète pour vos fonctions et classes avec exemples concrets.
Coller dans votre IA
Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.
Tu es un expert en documentation technique logicielle. Je dois documenter mon code [JavaScript/TypeScript] de manière professionnelle et complète pour que mes collègues puissent l'utiliser facilement.
Code à documenter :
[COLLER_LE_CODE]
Contexte :
- Audience : [EX: développeurs internes, contributeurs open-source, utilisateurs d'une librairie]
- Style de documentation : [EX: JSDoc standard, TSDoc pour TypeScript, format spécifique]
- Outil de génération : [EX: TypeDoc, JSDoc, Storybook]
- Niveau de détail requis : [EX: minimal pour usage interne, complet pour API publique]
Génère la documentation complète en :
- Description générale : une phrase de résumé puis un paragraphe détaillé expliquant le rôle, le contexte d'utilisation et les limitations importantes.
- Paramètres : documente chaque paramètre avec son type, si il est requis/optionnel, sa valeur par défaut et une description claire.
- Valeur de retour : type exact et description de ce qui est retourné, incluant les cas spéciaux (null, undefined, Promise rejetée).
- Exceptions : liste les erreurs qui peuvent être levées avec les conditions déclenchantes.
- Exemples de code : fournis 2-3 exemples concrets couvrant l'usage basique et des cas plus complexes.
- Annotations spéciales : @deprecated, @since, @see, @internal selon les besoins.
Assure-toi que la documentation est suffisamment précise pour qu'un développeur puisse utiliser la fonction sans lire son implémentation.
Personnaliser ce prompt avec Léa
Léa réécrit ce prompt pour ton métier et ton objectif précis — 3 questions suffisent.
Pourquoi ce prompt fonctionne
<p>Ce prompt est centré sur l'objectif final de la documentation : permettre à un développeur d'utiliser une fonction sans lire son implémentation. Cette contrainte force l'IA à produire une documentation exhaustive plutôt qu'une simple paraphrase du code.</p><p>La demande de 2-3 exemples concrets est l'élément le plus précieux de ce prompt : la documentation avec exemples a un taux d'adoption bien supérieur à la documentation textuelle seule. Les exemples réduisent drastiquement la courbe d'apprentissage pour les nouveaux utilisateurs d'une API.</p><p>L'adaptation au contexte (usage interne vs API publique) est importante car elle calibre le niveau de détail approprié : over-documenter du code interne simple est une perte de temps, tandis qu'under-documenter une API publique crée une dette de support.</p>
Cas d'usage
Résultat attendu
Des commentaires JSDoc/TSDoc complets avec descriptions, types, paramètres documentés, valeurs de retour et exemples de code.
Améliorez ce prompt
Passez ce prompt dans l'Optimiseur pour renforcer le contexte, les contraintes et le format attendu.
Améliore ce prompt avec l'OptimiseurCommentaires
- LéaIA
Pour du TypeScript, force l’option « Style de documentation : TSDoc » et ajoute l’instruction « Ne répète pas les types déjà présents dans la signature, décris leur sémantique et contraintes métier ». Cela produit une doc plus légère, compatible TypeDoc, et évite la désynchronisation lors des refactos de types.
Termes du glossaire
📬 Recevez de nouveaux prompts chaque semaine
Rejoignez notre newsletter et ne manquez aucun prompt.
Pour aller plus loin
Prompts similaires
Concevoir un cadre de conformité en tant que code
Automatiser les contrôles de conformité
Implémenter la Clean Architecture en pratique
Implémentez la Clean Architecture en pratique avec couches, ports et adaptateurs, use cases et tests unitaires sans infrastructure.
Prompt pour maîtriser le SSR et l'hydratation avec Next.js
Prompt complet pour diagnostiquer, implémenter et optimiser le Server-Side Rendering et l'hydratation dans une application Next.js, avec gestion des erreurs courantes.
Stratégie de scheduling avancée
Optimiser le placement des pods