Documentation Generator
Structured doc annotations (@param, @returns, @throws) are parseable by IDE tooling. The 'never seen this code' guideline prevents assumed-knowledge gaps.
Prompt
Generate documentation for the following {{language}} code.\n\n{{code_to_document}}\n\nDocumentation format: {{doc_format}}\n\nFor each public function/method/class, include:\n- A one-line summary of what it does\n- @param descriptions for all parameters with types and constraints\n- @returns description with type and possible values\n- @throws / @raises for all error conditions\n- @example with a realistic usage example\n- @since version (use {{version}})\n\nFor the module/file level:\n- A brief overview of the module's purpose\n- How it fits into the larger system\n- Any prerequisites or setup required\n\nStyle: Write for a developer who has never seen this code before. Be precise, not verbose.
Variables to customize
{{language}}{{code_to_document}}{{doc_format}}{{version}}
Why this prompt works
Structured doc annotations (@param, @returns, @throws) are parseable by IDE tooling. The 'never seen this code' guideline prevents assumed-knowledge gaps.
What you get when you save this prompt
Your workspace unlocks powerful tools to iterate and improve.
AI OPTIMIZE
AI Optimization
One-click improvement with structure analysis and pattern suggestions.
VERSION DIFF
Version History
Track every edit. Compare versions side-by-side with word-level diffs.
ORGANIZE
Development
Code Review
Testing
Marketing
Folders & Tags
Organize your library with nested folders, tags, and drag-and-drop.
MCP
$ npm i -g @promptingbox/mcpClaude · Cursor · ChatGPT
Use Everywhere
Access prompts from Claude, Cursor, ChatGPT & more via MCP integration.
Your prompts, organized
Save, version, and access your best prompts across ChatGPT, Claude, Cursor, and more.