P
💻DeveloppementDebutantAll AIs

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

Générer la documentation d'une fonction

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'Optimiseur

Commentaires

  • 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).

📬 Recevez de nouveaux prompts chaque semaine

Rejoignez notre newsletter et ne manquez aucun prompt.

Pour aller plus loin

Prompts similaires

💻DeveloppementDebutantAll AIs

Rédiger une requête ORM

Rédiger des requêtes ORM efficaces

440
💻DeveloppementAvanceAll AIs

Implémenter des tests basés sur les propriétés

Ajouter des tests basés sur les propriétés

501
💻DeveloppementIntermediaireAll AIs

Mettre en place une limitation de débit

Protéger les API contre les abus

398
💻DeveloppementIntermediaireAll AIs

Prompt GitHub Copilot pour générer du code JavaScript

GitHub Copilot, l'assistant de programmation basé sur l'intelligence artificielle développé par GitHub et OpenAI, a transformé la manière dont les développeurs écrivent du code JavaScript. En s'appuyant sur des milliards de lignes de code open source, Copilot est capable de générer des fonctions complètes, des classes, des modules et même des architectures entières à partir de simples descriptions en langage naturel. Pour tirer le meilleur parti de cet outil, il est essentiel de maîtriser l'art du prompt engineering appliqué à la génération de code. Un prompt bien structuré permet d'obtenir du code JavaScript propre, performant et conforme aux bonnes pratiques modernes (ES2024+, typage implicite, gestion d'erreurs, modularité). Dans ce guide, nous vous proposons des prompts optimisés pour GitHub Copilot qui vous permettront de générer du code JavaScript de qualité professionnelle, que vous développiez une API REST, un composant frontend, un script utilitaire ou une logique métier complexe. Chaque prompt a été conçu pour fournir suffisamment de contexte à Copilot tout en laissant la flexibilité nécessaire à une génération pertinente et adaptée à votre projet.

405