Documenter une fonction complexe
Générer la documentation d'une fonction
Coller dans votre IA
Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.
Rédigez une documentation JSDoc/docstring complète pour la fonction suivante. Incluez une description, @param avec types et descriptions, @returns, @throws pour tous les cas d'erreur, @example avec un usage réaliste et des notes de complexité si pertinent. Fonction : [COLLER_FONCTION]
Personnaliser ce prompt avec Léa
Léa réécrit ce prompt pour ton métier et ton objectif précis — 3 questions suffisent.
Cas d'usage
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 une fonction complexe, ajoutez les tags `@pre` et `@post` afin de formaliser les préconditions et postconditions — plus parlants qu’une longue description. Documentez aussi les effets de bord dans la phrase d’intro. Enfin, si la complexité varie selon les entrées, utilisez plusieurs `@complexity` en précisant le cas (pire, moyen).
Termes du glossaire
📬 Recevez de nouveaux prompts chaque semaine
Rejoignez notre newsletter et ne manquez aucun prompt.
Pour aller plus loin
Prompts similaires
Mise en œuvre de la CSP avec des nonces
Prévenir les XSS avec une CSP stricte
Planifier une migration d’un monolithe vers des microservices
Migrer des monolithes de façon incrémentielle
Créer un système de cache Redis performant et scalable
Un prompt complet pour concevoir et implémenter un système de cache Redis avec stratégies d'invalidation, gestion des erreurs et monitoring.
Prompt pour créer des Serverless Functions optimisées
Prompt complet pour concevoir des serverless functions production-ready sur Vercel ou AWS Lambda, couvrant le code, la sécurité, les performances et le déploiement.