comment-review-criteria
CommunityClarify code comments to improve correctness.
Software Engineering#code-quality#static-analysis#lint#code-comments#comment-review#design-clarity#llm-traces
Authorsato-dev1234
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Comment quality in source code can directly affect maintainability and correctness. This Skill defines what information comments should provide and establishes a standard for what constitutes acceptable explanations versus violations.
Core Features & Use Cases
- Comment Explainability: Comments should explain constraints and correctness factors, not unnecessary design rationale.
- Violation Flags: Detect and flag design rationale, LLM traces, redundant comments, and historical implementation notes.
- Review Scope: Applies to multiple languages and projects during code reviews to improve clarity and maintainability.
Quick Start
Review a codebase and apply the comment-review policy to flag non-informative or misaligned comments.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: comment-review-criteria Download link: https://github.com/sato-dev1234/claude-code-sample/archive/main.zip#comment-review-criteria Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.