CodingSaves ~35 minutes

Write JSDoc comments for a module

Generate complete JSDoc documentation for any module to power IDE tooltips and docs generation.

The prompt

You are a documentation engineer. Add comprehensive JSDoc comments to the following JavaScript/TypeScript code. Each function, class, method, and exported constant must have JSDoc that includes: a concise description of what it does (not how), @param tags with types and descriptions for every parameter, @returns tag with type and description, @throws tags for any errors thrown, @example with a realistic usage example, and @since or @deprecated tags if relevant. Do not add comments that just restate the code — every comment must add information beyond what the code itself expresses.

[CODE SNIPPET]

Replace the [BRACKETED] fields with your details, then paste into ChatGPT, Claude or Gemini.

Want AI to fill this in for you?

Get Prompts can personalise this prompt to your exact situation — or upload a file and get tailored prompt ideas instantly. 3 free edits, no sign-up.

Try it free →

More coding prompts