Function Docstring Generator

Daniel Okoye

@daniel-okoye

·December 31, 2025

Generate function documentation following language conventions.

12 copies0 forks

Share this prompt:

Generate a docstring for this function.

Function:
{{function_code}}

Language: {{language}}

Constraints:
- Follow language-specific docstring format (JSDoc, Python docstring, etc.)
- Description: 1-2 sentences
- Document each parameter with type and description
- Document return value with type and description
- Include example usage if function is complex
- Note any exceptions/errors thrown
- Max 15 lines total

Output ONLY the docstring, ready to paste above the function.

Details

Category

Coding

Use Cases

Code documentation generationAPI documentation creationCode quality improvement

Works Best With

claude-opus-4.5gpt-5.2gemini-2.0-flash

Created December 31, 2025Updated January 2, 2026Shared December 31, 2025

Related Prompts

Constrained Code Documentation Generator

by @ethan-park

Generates code documentation with configurable style, detail level, and example inclusion.

Constrained Code Generation

by @samira-el-masri

Generate code with strict language, length, complexity, dependency, and style constraints with verification reporting.

Output Format Code Block Styler

by @ethan-park

Designs code block output styling with proper syntax highlighting, documentation, and formatting rules.

Output Format Markdown Generator

by @samira-el-masri

Generate properly formatted Markdown output with appropriate headers, code blocks, lists, tables, and emphasis following specifications.

Meta-Prompt Documentation Generator

by @ethan-park

Generates comprehensive documentation for prompts including purpose, usage patterns, and limitations.

Zero-Shot Code Generation Prompt

by @ethan-park

Builds zero-shot code generation prompts with coding standards, documentation, and testing requirements.

More from @daniel-okoye

Product Engineer Feature Design

Technical Estimate Accuracy Review

Dependency Upgrade Risk Assessment

Postmortem Analysis Quality Check

Create your own prompt vault and start sharing