Prompt LibraryEngineering

Code Doc-Comment & API Reference Generator Prompt

Generate clear doc comments from a function signature.

The prompt

Write documentation for the function below.
Produce: a one-line summary, a full description, @param entries with types and constraints, @returns with type and failure modes, and one usage example.
Follow the existing doc style in the file. Do not document obvious parameters like "config".

Function:
```
{{code}}
```

Replace the {{fields}} with your own context and tighten the rules to match your domain.

Share this prompt