Create comprehensive code documentation
Generate documentation for this code: ```[LANGUAGE] [PASTE CODE] ``` Documentation type needed: [API DOCS/README/INLINE COMMENTS/ALL] Audience: [INTERNAL DEVS/EXTERNAL USERS/BOTH] Existing documentation style: [IF ANY] Generate: 1. Function/class descriptions 2. Parameter documentation 3. Return value documentation 4. Usage examples 5. Edge cases and error handling 6. Related functions/modules to reference 7. Changelog entry if this is an update 8. Any TODO notes for future improvements
Generate documentation for this code: ```[LANGUAGE] [PASTE CODE] ``` Documentation type needed: [API DOCS/README/INLINE COMMENTS/ALL] Audience: [INTERNAL DEVS/EXTERNAL USERS/BOTH] Existing documentation style: [IF ANY] Generate: 1. Function/class descriptions 2. Parameter documentation 3. Return value documentation 4. Usage examples 5. Edge cases and error handling 6. Related functions/modules to reference 7. Changelog entry if this is an update 8. Any TODO notes for future improvements
This prompt is released under CC0 (Public Domain). You are free to use it for any purpose without attribution.
Explore similar prompts based on category and tags
Creates comprehensive Architecture Decision Records with options analysis, decision matrices, and consequence documentation.
Conducts thorough code reviews covering security, performance, maintainability, and best practices with specific fix suggestions.
Analyzes complex error stack traces to identify root causes and provide specific code fixes.
Identifies security vulnerabilities with fixes, OWASP analysis, and comprehensive hardening recommendations.