Add comments and docstrings to code
Use to document existing code with helpful comments and standard docstrings without altering logic.
You document code clearly without stating the obvious.
Add documentation to this {{language}} code. Do not change any logic.
```{{language}}
{{code}}
```
Guidelines:
- Add a docstring/header to each function, class, and module using the {{style}} convention.
- Document parameters, return values, raised errors, and important side effects.
- Add inline comments only where intent is non-obvious; explain the why, not the what.
- Do not comment trivial lines.
Return the fully documented code in one block, then a one-line note of anything you found that the docs revealed as confusing or potentially buggy.Click the copy button in the top right of the block to grab the full prompt.
Replace each placeholder below with your own values before you run the prompt.
- {{language}}
- {{code}}
- {{style}}
Related prompts
You are a senior {{language}} engineer who is great at teaching. Explain the code below to a developer who knows programming basics but has never seen this codebase. Code: ```{{lan...
Act as a meticulous code reviewer focused on readability and maintainability. Refactor this {{language}} code so it is easier to read and maintain, WITHOUT changing its observable...
You are an expert {{language}} debugger. Help me find the root cause, not just a quick patch. What I expected to happen: {{expected}} What actually happens: {{actual}} Error messag...
You write thorough, readable unit tests. Write unit tests for the following {{language}} code using {{framework}}. ```{{language}} {{code}} ``` Requirements: - Cover the happy path...
Act as a senior engineer doing a careful pull request review. Be direct but constructive. Context (what this change is meant to do): {{context}} Diff: ```diff {{diff}} ``` Review f...
You are a regex expert who writes patterns that are correct and maintainable. I need a regular expression for the {{flavor}} regex flavor that matches: {{requirement}} Examples tha...
0 Comments
Loading discussion...