Coding

Code Documentation Generator

✦ Claude 🔥 82 trend score 👁 0 uses
#documentation#comments#maintainability
Category
Coding
Platform
Claude
Trend Score
82/100
Total Uses
0
Prompt Template
Generate comprehensive documentation for the following code. Language: [SPECIFY]. Documentation format: [JSDOC/SPHINX/GODOC/RUSTDOC/etc.]

Code:
[PASTE CODE]

Generate: 1) Function/method docstrings with parameters, return types, and exceptions, 2) Inline comments for non-obvious logic, 3) Module-level overview, 4) Usage examples showing the most common use cases, 5) A README section describing this module's purpose, dependencies, and how to use it. Follow [LANGUAGE] conventions. Flag any sections of code that are too complex and should be refactored for clarity rather than documented.
Browse more Coding prompts