DocumentationFREEACCESS AVAILABLEFC-DOC-012
Comment Claw
comment-claw
v0.2.0May 22, 2026Inline code comments and docstrings that explain why, not what — language-convention documentation strings that future developers thank you for
Comments that paraphrase the code are noise; comments that explain the "why" behind a non-obvious decision are gold. I write and audit inline documentation that surfaces constraints, edge cases, and the business rules that aren't recoverable from reading the implementation alone.
OpenClaw
Hermes
Claude Code
Codex
Cursor
Windsurf
Aider
OllamaPRIMARY ACTION
COMPATIBLE WITH
OpenClawHermesClaude CodeCodex+4
8 compatible tools3 output formats
When to Use
- Create practical README and setup docs
- Document API behavior with clarity
- Maintain reliable changelogs
- Reduce onboarding friction
Compatible Frameworks
OpenClawHermesClaude CodeCodexCursorWindsurfAiderOllama8 TOOLS
Quality Gates
- Comments explain why, not what
- Public APIs documented with JSDoc
- No obvious or redundant comments
- Anti-patterns documented with examples
- Complete and structured response
3 GATES DEFINED
Expected Outputs
Code Comments Audit with Noise-to-Signal RatioJSDoc/Docstring Coverage ReportDeveloper-Facing Internal Docs for Non-Obvious Modules
Native exports per tool
OpenClaw10 files
openclaw/AGENTS.mdopenclaw/SOUL.mdopenclaw/TOOLS.md+7 moreHermes5 files
hermes/skills/flickclaw/comment-claw/SKILL.mdhermes/skills/flickclaw/comment-claw/references/workflow.mdhermes/skills/flickclaw/comment-claw/references/quality-gates.md+2 moreClaude Code6 files
claude-code/CLAUDE.mdclaude-code/.claude/skills/comment-claw/SKILL.mdclaude-code/.claude/skills/comment-claw/references/workflow.md+3 moreCodex5 files
codex/AGENTS.mdcodex/.flickclaw/agents/comment-claw/codex.mdcodex/.flickclaw/agents/comment-claw/workflow.md+2 moreCursor3 files
cursor/.cursor/rules/flickclaw-comment-claw.mdccursor/.cursor/rules/flickclaw-comment-claw-workflow.mdccursor/.cursor/rules/flickclaw-comment-claw-quality-gates.mdcWindsurf3 files
windsurf/.windsurf/rules/flickclaw-comment-claw.mdwindsurf/.windsurf/rules/flickclaw-comment-claw-workflow.mdwindsurf/.windsurf/rules/flickclaw-comment-claw-quality-gates.mdAider3 files
aider/CONVENTIONS.mdaider/aider.mdaider/.aider.conf.ymlOllama4 files
ollama/Modelfileollama/system-prompt.mdollama/template.md+1 moreInstall Commands
Install the FlickClaw CLI, then select your AI agent framework below to get the correct install command.
Step 1: Install CLI (one-time)
npm install -g @flickclaw/cli@latestStep 2: Select Framework
OpenClaw
npm exec --yes @flickclaw/cli@latest -- install comment-claw --target openclawDownload as ZIP
Example Prompt
Try this prompt with Comment Claw to see what it can do:
Review the documentation and identify gaps. Generate Code Comments Audit with Noise-to-Signal Ratio, JSDoc/Docstring Coverage Report, Developer-Facing Internal Docs for Non-Obvious Modules covering setup, API reference, and troubleshooting.Example Output
IllustrativeWhat a typical Comment Claw report looks like:
# Comment Claw — Assessment Report **Project**: api-docs-site **Context**: a developer documentation site with OpenAPI specs and tutorials **Generated**: 2026-07-10 ## Executive Summary The Comment Claw completed its review of api-docs-site (a developer documentation site with OpenAPI specs and tutorials). 3 findings were identified with concrete remediation steps. All quality gates were verified before delivery. ## Findings | # | Severity | Area | Finding | Recommended Action | |---|----------|------|---------|-------------------| | 1 | **P1** | Structure | Quickstart buried 3 levels deep in navigation | Promote Quickstart to top-level with 5-minute timebox | | 2 | **P2** | Completeness | Webhook events missing from API reference | Document all webhook types with payload examples | | 3 | **P2** | Examples | Code samples lack error handling | Add try/catch blocks and error response examples | ## Quality Gates - [✓] no_comment_paraphrases_the_immediately_visible_code - [✓] every_todo_has_an_owner_and_tracking_link - [✓] public_api_surface_has_jsdoc_or_equivalent ## Outputs Generated - **Code Comments Audit with Noise-to-Signal Ratio**: Included in the report above. - **JSDoc/Docstring Coverage Report**: Included in the report above. - **Developer-Facing Internal Docs for Non-Obvious Modules**: Included in the report above. ## Validation - [x] All quality gates passed (3/3) - [x] 3 findings documented with severity and remediation - [x] 3 output sections generated - [x] Evidence collected and referenced --- *This is an illustrative example output from FlickClaw. Results vary based on project context.*
RELATED AGENTS