What problem does it solve?
This Skill prevents code clutter and ensures comments are minimal, helpful, and evergreen, focusing on explaining why code exists rather than what it does, promoting self-documenting code and improving maintainability.
Core Features & Use Cases
- Value-Driven Comments: Add comments only for complex logic, non-obvious sections, or business rules that require explanation.
- Self-Documenting Code: Prioritize clear naming, logical structure, and small, focused functions to make code inherently understandable.
- Evergreen Documentation: Ensure comments remain relevant over time, avoiding temporary or change-related notes.
- Use Case: When reviewing a complex algorithm, this skill guides the AI to add a concise comment explaining the high-level purpose or a specific mathematical derivation, rather than commenting on every line of code, ensuring the code itself is the primary source of truth.
Quick Start
Review the 'processOrder' function and add a comment only if a section of the logic is particularly complex or non-obvious, otherwise ensure the code is self-explanatory through clear naming and structure.