Document a complex function
Generate function documentation
Paste in your AI
Paste this prompt in ChatGPT, Claude or Gemini and customize the variables in brackets.
Write comprehensive JSDoc/docstring documentation for the following function. Include a description, @param with types and descriptions, @returns, @throws for all error cases, @example with realistic usage, and complexity notes if relevant. Function: [paste function]
Personalize this prompt with LĂ©a
Léa rewrites this prompt for your job and your exact goal — 3 quick questions.
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
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).
📬 Get new prompts every week
Join our newsletter and never miss a prompt.
Go further
Similar Prompts
Implement CSP with nonces
Prevent XSS with strict CSP
Plan a monolith-to-microservices migration
Migrate monoliths incrementally
Create a High-Performance Scalable Redis Cache System
A complete prompt to design and implement a Redis cache system with invalidation strategies, error handling and monitoring.
Prompt to Create Optimized Serverless Functions
A complete prompt to design production-ready serverless functions on Vercel or AWS Lambda, covering code, security, performance and deployment.