PromptCC0-1.0 di9 pick

In-code documentation

Quick documentation of existing code for your team or your future self.

This Prompt What does it do?

Quick documentation of existing code for your team or your future self.

Download docstring-comments-generate.md Build a custom version 8 Download · 16 Views

Full text Prompt

Write in-code documentation for this [language] code: [code]. Give every function or class a docstring in the language's standard style ([JSDoc/PHPDoc/Google style]) with description, parameters, return value, and possible errors. Add inline comments only where the why is unclear, not the what. Do not change the code.

English version (for image and video models)

Write in-code documentation for this [language] code: [code]. Give every function or class a docstring in the language's standard style ([JSDoc/PHPDoc/Google style]) with description, parameters, return value, and possible errors. Add inline comments only where the why is unclear, not the what. Do not change the code.

Build a custom version for your project

Write your project details; to the end of Prompt is added, and you get a file that is given to the AI without extra explanation. Everything is built in your browser and no data goes to the server.

Language of the added section
Preview of the final file

Frequently asked questions

Prompt “In-code documentation” — how do I use it?

Click the copy button, fill in any variables under “Fill in the variables”, and paste the text into ChatGPT, Claude, Copilot, Cursor . For an answer in your language, add at the end: “Answer in my language”.

Is using this prompt free?

Yes. This prompt is from the collection awesome-persian-prompts With license CC0-1.0 collected and free for personal and commercial use.

Prompts Related in “Documentation and technical writing”

All

Type a few letters of the topic; spelling variants are treated as the same.