Provides rules and best practices for writing clear, valuable, and standardized code comments.
Enhances code readability and maintainability by applying a consistent and meaningful commenting style. This skill enforces clear formatting rules for standalone, inline, and multi-line comments, and advocates for explaining the 'why' behind complex code rather than simply narrating the 'what'. It helps eliminate redundant or unhelpful comments and provides language-specific conventions, such as GoDoc, to ensure the generated code is not only functional but also easy for developers to understand and maintain.
Key Features
01Defines strict formatting rules for standalone vs. inline comments.
02Provides guidelines for avoiding and removing unnecessary comments.
03Includes language-specific conventions, such as GoDoc style for Go.
0411 GitHub stars
05Promotes explaining the 'why' of the code, not just the 'what'.
06Enforces the use of `//` for all multi-line comments.
Use Cases
01Refactoring a codebase to improve comment quality and consistency.
02Generating code with comments that explain complex logic or design decisions.
03Establishing a clear commenting standard for a new project or development team.
