Coding

Code Documentation Generator

✦ Claude 🔥 82 puntuación tendencia 👁 0 usos
#documentation#comments#maintainability
Categoría
Coding
Plataforma
Claude
Puntuación Tendencia
82/100
Total Usos
0
Plantilla de Prompt
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.
Ver más prompts de Coding