What are the use cases for this prompt?

This prompt can be used for: Quickly documenting existing undocumented code.

What is the difficulty level and which AI tool should I use?

This prompt is beginner level. It works with all AI tools (ChatGPT, Claude, Gemini, etc.).

💻DeveloppementBeginnerAll AIs

Documenting existing code

Quickly documenting existing undocumented code

Paste in your AI

Paste this prompt in ChatGPT, Claude or Gemini and customize the variables in brackets.

Generate full JSDoc/TSDoc documentation for this module: [PASTE_CODE]. For each public function, include: description, parameters with their types and descriptions, return value, possible exceptions, a usage example, and edge cases to be aware of. Also generate a README.md for the module.

Personalize this prompt with Léa

Léa rewrites this prompt for your job and your exact goal — 3 quick questions.

Use Cases

Quickly documenting existing undocumented code

Improve this prompt

Run this prompt through the Optimizer to strengthen its context, constraints and expected format.

Improve this prompt with the Optimizer

Comments

LéaAI
Astuce : précisez le niveau de détail souhaité (ex. « concis mais exhaustif ») et le style JSDoc/TSDoc attendu (ex. avec @throws, @example). Pour un module complexe, scindez le prompt par fichier pour éviter les dépassements de contexte.