---
name: comment-gen
description: Add meaningful inline comments to complex code. Use when documentation is lacking.
---

# Comment Generator

Good comments explain WHY, not WHAT. This tool reads your code, understands the intent, and adds comments that actually help future readers.

**One command. Zero config. Just works.**

## Quick Start

```bash
npx ai-comment ./src/algorithm.ts
```

## What It Does

- Adds inline comments explaining the reasoning behind complex code
- Focuses on WHY the code does something, not WHAT it does
- Supports multiple verbosity levels for different audiences
- Preserves your existing formatting

## Usage Examples

```bash
# Add concise comments
npx ai-comment ./src/algorithm.ts

# More detailed explanations
npx ai-comment ./src/utils.js --style detailed

# For junior developer onboarding
npx ai-comment ./src/parser.ts --style beginner

# Preview without changing files
npx ai-comment ./src/complex.ts --dry-run
```

## Best Practices

- **Don't over-comment** - simple code doesn't need comments
- **Focus on complex logic** - business rules, edge cases, workarounds
- **Review the output** - make sure comments are accurate
- **Update when code changes** - stale comments are worse than none

## When to Use This

- Inherited a codebase with no documentation
- Onboarding new team members
- Complex algorithms that need explanation
- Before going on vacation so others can maintain your code

## Part of the LXGIC Dev Toolkit

This is one of 110+ free developer tools built by LXGIC Studios. No paywalls, no sign-ups, no API keys on free tiers. Just tools that work.

**Find more:**
- GitHub: https://github.com/LXGIC-Studios
- Twitter: https://x.com/lxgicstudios
- Substack: https://lxgicstudios.substack.com
- Website: https://lxgicstudios.com

## Requirements

No install needed. Just run with npx. Node.js 18+ recommended. Needs OPENAI_API_KEY environment variable.

```bash
npx ai-comment --help
```

## How It Works

Reads your code file, sends it to GPT-4o-mini, and receives the same code with meaningful inline comments added. The AI analyzes control flow, business logic, and edge cases to explain the reasoning.

## License

MIT. Free forever. Use it however you want.


---
Source attribution: kbarbel640-del
Original project: https://github.com/kbarbel640-del/skills/blob/e7e336ac628c3e3bd771aff1aaa469c93778f94a/skills/lxgicstudios/comment-gen/SKILL.md
License: MIT
License information: https://opensource.org/license/mit
Original upstream instructions; downloaded from Dave AI.

## Upstream license notice

MIT License

Copyright (c) 2026 clawdbot

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



# Dave AI resource metadata

Creator / publisher: kbarbel640-del
Original project: https://github.com/kbarbel640-del/skills/blob/e7e336ac628c3e3bd771aff1aaa469c93778f94a/skills/lxgicstudios/comment-gen/SKILL.md
Attribution basis: Source repository record

Fields of work: Content & Media, Design, Development & Engineering
Roles: Backend Developer, Frontend Developer, Full-Stack Developer, Technical Writer, UX Writer
Specialties: Backend, Cross Platform, Frontend
Tools: GitHub, Npx
Country applicability: Country not specified
Classification basis: Source catalog labels
Instruction SHA-256: cfa365b25ee5cb589b18696eb24f87ec51583cfb13c13f108b1a9b518bb68447