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
Answer 3 questions and LĂ©a tailors the prompt to your situation.
Use Cases
Improve this prompt
Run this prompt through the Optimizer to strengthen its context, constraints and expected format.
Improve this prompt with the OptimizerComments
- 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.
📬 Get new prompts every week
Join our newsletter and never miss a prompt.