💻Software Development

Code Comment Standards

Documentation comment templates for functions, classes, and modules.

9 snippets included|Free to download|Works with TypeFire for macOS
Download TypeFire for macOS
zsdcc1

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 regards
zsdcc2

Customized 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]
zsdcc3

Template Confirmation

Hi {{cursor}},

Quick update on template confirmation:

[Key information]

Let me know if you have any questions.

Best
zsdcc4

Basic 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]
zsdcc5

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 regards
zsdcc6

Urgent 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]
zsdcc7

Routine Draft

Hi {{cursor}},

Quick update on routine draft:

[Key information]

Let me know if you have any questions.

Best
zsdcc8

Personalized 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]
zsdcc9

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 regards

When to use this template

Customize for your workflow

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

Use these snippets in TypeFire

Download the template pack, drop the .md files into your TypeFire snippets folder, and start expanding with abbreviations instantly.

Get TypeFire Free