comment-usage
This rule dictates how comments should be used within the codebase to enhance understanding and avoid clutter.
Best use case
comment-usage is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
This rule dictates how comments should be used within the codebase to enhance understanding and avoid clutter.
Teams using comment-usage should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/comment-usage/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How comment-usage Compares
| Feature / Agent | comment-usage | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
This rule dictates how comments should be used within the codebase to enhance understanding and avoid clutter.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Comment Usage Skill <identity> You are a coding standards expert specializing in comment usage. You help developers write better code by applying established guidelines and best practices. </identity> <capabilities> - Review code for guideline compliance - Suggest improvements based on best practices - Explain why certain patterns are preferred - Help refactor code to meet standards </capabilities> <instructions> When reviewing or writing code, apply these guidelines: - Use comments sparingly, and when you do, make them meaningful. - Don't comment on obvious things. Excessive or unclear comments can clutter the codebase and become outdated. - Use comments to convey the "why" behind specific actions or explain unusual behavior and potential pitfalls. - Provide meaningful information about the function's behavior and explain unusual behavior and potential pitfalls. </instructions> <examples> Example usage: ``` User: "Review this code for comment usage compliance" Agent: [Analyzes code against guidelines and provides specific feedback] ``` </examples> ## Memory Protocol (MANDATORY) **Before starting:** ```bash cat .claude/context/memory/learnings.md ``` **After completing:** Record any new patterns or exceptions discovered. > ASSUME INTERRUPTION: Your context may reset. If it's not in memory, it didn't happen.
Related Skills
context7-usage
Patterns for using Context7 MCP for library documentation (v2.25)
code-commenting
Comprehensive code commenting methodology for Python projects. Use when user asks to add comments, annotations, or documentation to Python code files. Provides structured approach with module docstrings, class/function documentation, section separators, and inline comments.
anthropic-usage
Check Anthropic API usage and costs for any time period. Use when the user asks about API costs, usage, spending, or billing for their Anthropic account. Supports natural language periods like "last week", "yesterday", "january 2025", specific dates, or date ranges.
alpine-js-usage-rules
Guidelines for using Alpine.js for declarative JavaScript functionality.
virtual-environment-usage
Mandates the use of virtual environments for isolating project dependencies and ensuring reproducibility.
remove-ai-comments
Removes redundant, obvious, or "AI-flavored" comments from code to improve signal-to-noise ratio. Use when the user asks to "clean up comments", "remove AI comments", or makes a general request to refactor verbose code documentation.
ai-usage-coach
Help users get more value from AI assistants by suggesting better prompting techniques, surfacing underused features, and identifying workflow improvements. Use when users ask things like "how can I use Claude better?", "what features am I missing?", "give me tips for prompting", "what can you do?", "I feel like I'm not getting the most out of this", or when they explicitly ask for help improving their AI usage. Also use when users seem frustrated with results or are clearly using suboptimal patterns.
adding-markdown-highlighted-comments
Use when adding responses to markdown documents with user-highlighted comments, encountering markup errors, or unsure about mark tag placement - ensures proper model-highlight formatting with required attributes and correct placement within markdown elements
ffmpeg-usage
ffmpeg recipes and best practices: convert, concatenate, merge, resize, compress, GIF creation, audio extraction, subtitles, optimize for social platforms.
address-github-comments
Use when you need to address review or issue comments on an open GitHub Pull Request using the gh CLI.
add-review-comment
Add a review comment to a GitHub pull request.
mongodb_usage
This skill should be used when user asks to "query MongoDB", "show database collections", "get collection schema", "list MongoDB databases", "search records in MongoDB", or "check database indexes".