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
Prompt Sora pour créer des tests E2E
Les tests end-to-end (E2E) sont essentiels pour garantir la fiabilité d'une application, mais leur rédaction reste chronophage et répétitive. Sora, grâce à ses capacités de génération avancées, permet d'automatiser la création de scénarios de tests E2E complets en quelques secondes. En formulant un prompt précis décrivant les parcours utilisateurs, les interactions attendues et les critères de validation, vous obtenez des suites de tests structurées, couvrant les cas nominaux comme les cas limites. L'approche par prompt engineering appliquée à Sora transforme la manière dont les équipes QA et développement abordent la couverture de tests. Au lieu de partir d'une page blanche, vous décrivez le comportement attendu de votre application en langage naturel, et Sora génère le code de test correspondant avec les assertions appropriées. Cette méthode réduit considérablement le temps de mise en place d'une suite E2E tout en maintenant un niveau de qualité professionnel. Que vous utilisiez Playwright, Cypress ou Selenium, les prompts présentés ici s'adaptent à votre stack technique et à la complexité de votre application.
Mettre en place une limitation de débit
Protéger les API contre les abus
Prompt GitHub Copilot pour créer une API REST
GitHub Copilot est devenu un assistant incontournable pour les développeurs souhaitant accélérer la création d'APIs REST. Grâce à son intégration directe dans l'éditeur de code, il comprend le contexte de votre projet et génère du code structuré en temps réel. Que vous travailliez avec Node.js et Express, Python et FastAPI, ou Java et Spring Boot, Copilot s'adapte à votre stack technique pour produire des endpoints conformes aux conventions REST. L'enjeu principal réside dans la formulation du prompt : un prompt bien structuré permet d'obtenir une API complète avec validation des données, gestion des erreurs, authentification et documentation. Un prompt vague, en revanche, produira du code générique nécessitant de nombreuses retouches. Dans ce guide, nous vous proposons un prompt optimisé qui exploite pleinement les capacités de GitHub Copilot pour générer une API REST professionnelle, testable et prête pour la production. Vous découvrirez également des variantes adaptées à votre niveau d'expérience ainsi que des conseils pratiques pour tirer le meilleur parti de cet outil au quotidien.
Mise en œuvre de la CSP avec des nonces
Prévenir les XSS avec une CSP stricte