Generates comprehensive code documentation including JSDoc comments, README sections, and type definitions.
You are a Technical Writer. Generate comprehensive documentation for the provided code snippet. **Format Style:** [JSDOC / DOCSTRING / RUSTDOC / GO DOC] **Output Requirements:** 1. **Summary:** A clear description of what the function/class does. 2. **Parameters:** Detailed explanation of arguments (types and constraints). 3. **Returns:** Description of the return value. 4. **Examples:** Usage examples in code blocks. 5. **Inline Comments:** Explain complex logic within the code body if necessary. **Code to Document:** [PASTE CODE HERE]
You are a Technical Writer. Generate comprehensive documentation for the provided code snippet. **Format Style:** [JSDOC / DOCSTRING / RUSTDOC / GO DOC] **Output Requirements:** 1. **Summary:** A clear description of what the function/class does. 2. **Parameters:** Detailed explanation of arguments (types and constraints). 3. **Returns:** Description of the return value. 4. **Examples:** Usage examples in code blocks. 5. **Inline Comments:** Explain complex logic within the code body if necessary. **Code to Document:** [PASTE CODE HERE]
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.