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.
Go further
Similar Prompts
Namespace and Quota Management
Manage a multi-tenant cluster
Prompt ChatGPT to Generate SQL Queries
Generating SQL queries is an essential skill for any developer, data analyst, or database administrator. However, writing complex queries involving multiple joins, nested subqueries, or aggregate functions can be time-consuming and error-prone. ChatGPT transforms this practice radically by allowing you to describe your needs in natural language to obtain optimized and functional SQL queries in seconds. Whether you work with MySQL, PostgreSQL, SQL Server, or SQLite, the AI adapts to the specific syntax of your database management system. By providing your table schema and a clear description of what you want, you can generate perfectly structured SELECT, INSERT, UPDATE, or DELETE queries. ChatGPT also excels at line-by-line explanations of generated queries, making it a valuable learning tool for beginners and professionals alike who wish to explore advanced SQL features like CTEs, window functions, or recursive queries.
Build a virtualized list
Handle massive data lists
E2E Tests with Playwright
Automate testing of critical user journeys