comment-skill
CommunityImprove code docs without changing behavior.
Software Engineering#doc comments#public types#exported functions#Index block#orchestrator code#comment-only
Authorjoshka0
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Comment-skill helps you add clearer, language-agnostic documentation to existing code so teams can understand exported modules, public types, and key functions without relying on tribal knowledge or outdated docstrings.
Core Features & Use Cases
- Docs for packages/modules and public APIs: Adds or refines doc comments for packages/modules, exported/public types, and important exported/public functions.
- Index blocks for orchestrator logic: For hub/orchestrator code (skills entrypoints, indexers, workers, stores, supervisors, transaction boundaries), it can include a structured Index block that summarizes purpose, flow, side effects, concurrency, failure modes, and related symbols.
- Language-agnostic, safe edits: Keeps changes limited to comments (and trivial whitespace) and does not alter runtime behavior, logic order, or identifiers.
Quick Start
Ask comment-skill to update documentation comments for a specific folder or module scope, such as “comment-skill in the configs/ directory: improve doc comments for exported functions and types, and add Index blocks where this is hub/orchestrator code.”
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-skill Download link: https://github.com/joshka0/foxctl/archive/main.zip#comment-skill 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 471,000+ vetted skills library on demand.