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
Réponds à 3 questions, Léa adapte le prompt à ta situation.
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
Prompt Claude pour créer une architecture logicielle
La conception d'une architecture logicielle est une étape fondamentale qui détermine la maintenabilité, la scalabilité et la robustesse d'un projet. Claude excelle dans ce domaine grâce à sa capacité à analyser des contraintes techniques complexes, à proposer des patterns architecturaux adaptés et à anticiper les problèmes de design avant qu'ils ne surviennent en production. Que vous démarriez un nouveau projet from scratch, que vous refactoriez un monolithe vers des microservices, ou que vous évaluiez différentes options technologiques, Claude peut vous accompagner à chaque étape du processus décisionnel. En lui fournissant un contexte précis sur vos contraintes (équipe, budget, trafic attendu, stack existante), vous obtenez des recommandations architecturales argumentées, des diagrammes de composants, des ADR (Architecture Decision Records) structurés et des plans de migration concrets. L'approche itérative avec Claude permet d'explorer plusieurs alternatives, de comparer leurs trade-offs et de converger vers une solution qui équilibre pragmatisme et excellence technique. C'est comme avoir un architecte logiciel senior disponible en permanence pour challenger vos idées et enrichir votre réflexion.
Concevoir une politique IAM à moindre privilège
Appliquer le principe de moindre privilège IAM
Prompt Claude pour créer une API REST
La création d'une API REST est une tâche fondamentale du développement backend moderne. Que vous construisiez un microservice, une application SaaS ou une plateforme complète, une API bien structurée est la colonne vertébrale de votre architecture. Claude excelle dans la génération d'APIs REST complètes en respectant les bonnes pratiques : structure de projet claire, validation des données, gestion des erreurs, authentification, documentation OpenAPI et tests. Plutôt que de partir de zéro ou de copier des boilerplates obsolètes, vous pouvez décrire précisément vos besoins métier à Claude et obtenir une API production-ready en quelques minutes. L'avantage majeur réside dans la capacité de Claude à adapter le code au framework de votre choix (Express, FastAPI, NestJS, Django REST, Spring Boot) tout en appliquant les conventions RESTful : verbes HTTP appropriés, codes de statut corrects, pagination, filtrage et versioning. Ce guide vous propose des prompts optimisés pour tirer le meilleur parti de Claude dans la conception et l'implémentation de vos APIs REST, du prototype rapide à l'architecture microservices complète.
Concevoir une API versionnée
Faire évoluer une API publique sans casser les intégrations