Writing Code Comments
Provides rules and best practices for writing clear, valuable, and standardized code comments.
The source repository doesn't declare a license. Check its terms before reusing the code.
Key features
- Defines strict formatting rules for standalone vs. inline comments.
- Provides guidelines for avoiding and removing unnecessary comments.
- Includes language-specific conventions, such as GoDoc style for Go.
- Promotes explaining the 'why' of the code, not just the 'what'.
- Enforces the use of `//` for all multi-line comments.
Use cases
- Refactoring a codebase to improve comment quality and consistency.
- Generating code with comments that explain complex logic or design decisions.
- Establishing a clear commenting standard for a new project or development team.
FAQ
What does the Writing Code Comments skill do?
This skill provides Claude with a set of strict rules and best practices for writing clear, valuable, and standardized code comments, ensuring your code is easy to understand and maintain.
What key capabilities does it provide?
It defines strict formatting for standalone vs. inline comments, promotes explaining the 'why' over the 'what', provides guidelines for removing redundant comments, and includes language-specific conventions like GoDoc.
How does this skill improve my workflow?
It automates the enforcement of comment standards, saving you time during development and code reviews. By generating comments that explain the 'why' of the code, it helps your team understand complex logic faster.
When should I use this skill?
Use this skill when you want Claude to help document new code, refactor existing comments to meet high standards, or ensure consistency in team projects. It's ideal for improving code review and long-term maintainability.
Related skills
Website Maintainer
Manages VitePress-based documentation sites with support for multi-language content, configuration sharding, and translation workflows.
Learning Documentation20,67612 ptsLLM-Native Translator
Translates SpecWeave documentation, templates, and CLI messages into multiple languages using the current LLM session.
Learning Documentation1012 ptsAgent Documentation Management
Enforces documentation standards, structure, and best practices for agent-focused repositories.
Learning Documentation2912 pts