Add Docstrings And Comments ChatGPT Prompt

डॉकस्ट्रिंग और कमेंट्स जोड़ें

Act as a careful code documenter. Add clear in-code documentation to my Python code so a new teammate can understand it quickly.

[paste your code here]

Documentation style: Language default

Rules:
- Add a docstring or doc comment to every function, class and module: purpose, parameters with types, return value, errors raised and one short usage example where helpful.
- Add inline comments only where the "why" is not obvious. Do not comment things the code already says (no "increment i by 1").
- Mark anything that looks like a bug or a hidden assumption with a TODO comment and a short note, but do not change the logic.
- Keep names and behaviour exactly the same.

Return:
1. The fully documented code in one block.
2. A short list of the TODOs you added and why.
3. Two suggestions for naming improvements I could make later.

• docstrings
• code comments
• documentation
• clean code
• code samjhana
• teamwork

Options you can change

• Programming Language: Python, JavaScript, TypeScript, Java, Kotlin, C#, Go, PHP
• Doc Style: Language default, Google style, NumPy style, JSDoc, KDoc, Javadoc

The prompt above uses the default choice. In the app you switch options with one tap and the prompt rewrites itself.

How to use it

1. Copy the prompt.
2. Open ChatGPT or Gemini and paste it.
3. Replace anything in [square brackets] with your own details, then send.
4. Ask for changes: "shorter", "more formal", "in Hindi".