writing-comments

What problem does it solve?

This Skill eliminates inconsistent, unclear, or unnecessary code comments that lead to confusion and maintenance headaches, ensuring every line of documentation adds value and clarity.

Core Features & Use Cases

• Standardized Comment Style: Enforces consistent formatting for standalone and inline comments, improving code readability.
• GoDoc Conventions: Guides on language-specific best practices, such as GoDoc style for exported items.
• Value-Driven Comments: Teaches when to comment (explaining "why") and when to avoid unnecessary comments (when code is self-explanatory).
• Use Case: Ensure all new code contributions adhere to a consistent, high-quality commenting standard, making codebases easier to understand and maintain for future developers.

Quick Start

BAD

// Start dispatcher

GOOD

// Start the dispatcher.

GOOD

// Workers must be spawned before sending the first event // or there will be a deadlock. for i := 0; i < numWorkers; i++ { go worker() }