ai-comment

Add meaningful inline comments to complex code. Explains the WHY, not the WHAT.

Install

npm install -g ai-comment

Usage

npx ai-comment ./src/algorithm.ts
# → Comments added to ./src/algorithm.ts

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

npx ai-comment ./src/parser.ts --dry-run
# → Preview without modifying the file

Setup

export OPENAI_API_KEY=sk-...

Styles

• concise - Short, to-the-point comments (default)
• detailed - More thorough explanations
• beginner - Explains concepts for junior developers

License

MIT