Code Comment Standards
Documentation comment templates for functions, classes, and modules.
Comprehensive Communication
Hi {{cursor}},
Thank you for your patience while we reviewed comprehensive communication.
Here are the key details:
- [Detail 1]: [Specific information]
- [Detail 2]: [Specific information]
- [Detail 3]: [Specific information]
Please review the above and let me know if you have any questions or need additional information.
Thank you for your time and attention. I will follow up if I do not hear back by [date].
Best regardsCustomized Reminder
Customized Reminder
Date: {{date}}
Prepared by: {{cursor}}
Summary:
[Brief overview of customized reminder]
Details:
1. [Key point or finding]
2. [Key point or finding]
3. [Key point or finding]
Action Items:
- [Action item 1] - Due: [Date]
- [Action item 2] - Due: [Date]
- [Action item 3] - Due: [Date]
Next Steps:
[Description of what happens next]
Notes:
[Additional context or considerations]Template Confirmation
Hi {{cursor}},
Quick update on template confirmation:
[Key information]
Let me know if you have any questions.
BestBasic Report
Basic Report
Date: {{date}}
Status: [Active/Pending/Complete]
Owner: {{cursor}}
Description:
[Detailed description of basic report]
Key Points:
- [Point 1]
- [Point 2]
- [Point 3]
Timeline:
- Start: [Date]
- Milestone 1: [Date]
- Completion: [Date]
Notes:
[Additional information]Advanced Guide
Hi {{cursor}},
I hope this message finds you well. I wanted to share an update about advanced guide.
Here are the key details:
- [Detail 1]: [Specific information]
- [Detail 2]: [Specific information]
- [Detail 3]: [Specific information]
Please review the above and let me know if you have any questions or need additional information.
If you need any clarification, I am available to chat anytime this week.
Best regardsUrgent Brief
Urgent Brief
Date: {{date}}
Prepared by: {{cursor}}
Summary:
[Brief overview of urgent brief]
Details:
1. [Key point or finding]
2. [Key point or finding]
3. [Key point or finding]
Action Items:
- [Action item 1] - Due: [Date]
- [Action item 2] - Due: [Date]
- [Action item 3] - Due: [Date]
Next Steps:
[Description of what happens next]
Notes:
[Additional context or considerations]Routine Draft
Hi {{cursor}},
Quick update on routine draft:
[Key information]
Let me know if you have any questions.
BestPersonalized Format
Personalized Format
Date: {{date}}
Status: [Active/Pending/Complete]
Owner: {{cursor}}
Description:
[Detailed description of personalized format]
Key Points:
- [Point 1]
- [Point 2]
- [Point 3]
Timeline:
- Start: [Date]
- Milestone 1: [Date]
- Completion: [Date]
Notes:
[Additional information]Final Notice
Hi {{cursor}},
I wanted to follow up with you about final notice.
Here are the key details:
- [Detail 1]: [Specific information]
- [Detail 2]: [Specific information]
- [Detail 3]: [Specific information]
Please review the above and let me know if you have any questions or need additional information.
Thank you for your time and attention. I will follow up if I do not hear back by [date].
Best regardsWhen to use this template
- JSDoc / TSDoc / docstring boilerplate when adding new functions. Type the abbreviation, fill in the description, params, returns.
- Module / file header comments that explain what a file is responsible for.
- Inline TODO / FIXME comments with consistent metadata (date, owner, ticket number).
Customize for your workflow
- Match the language and tooling. Python uses docstrings, Rust uses `///`, TypeScript uses JSDoc. Snippets should be language-specific.
- Don't comment what the code says. Comment why the code is the way it is, especially for non-obvious tradeoffs.
Common questions
Should every function have a docstring?
Public APIs yes. Internal helpers if the name doesn't fully convey behavior. Trivial getters and setters don't need them.
What about TODO comments — useful or noise?
Useful when scoped (with a ticket reference and owner). Noise when stale (TODO from 2020 with no context). Periodically purge or escalate to actual issues.
Related reading
More Software Development Templates
Code Review Comments
Constructive code review feedback templates for common issues.
12 snippetsPull Request Templates
PR description formats with context, testing, and review guidance.
9 snippetsBug Report Templates
Structured bug report formats with reproduction steps and environment details.
8 snippetsTechnical Documentation
API documentation, README templates, and architecture decision records.
10 snippetsGit Commit Messages
Conventional commit message templates for features, fixes, and refactors.
11 snippetsRelease Notes Templates
Changelog and release announcement formats for software updates.
8 snippetsTechnical RFC Templates
Request for comments templates for proposing technical changes.
8 snippetsOn-Call Handoff Templates
On-call rotation handoff notes and incident status templates.
10 snippetsUse these snippets in TypeFire
Download the template pack, drop the .md files into your TypeFire snippets folder, and start expanding with abbreviations instantly.