Skills
.Work. You
Rest

inline-comments

Community

Inline comments that explain why.

Software Engineering#commenting#maintainability#best-practices#code-review#code-understanding#inline-comments
Authorberkcangumusisik
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Non-obvious code sections often hide intent, making maintenance and reviews harder. This skill adds inline comments that explain the rationale behind complex logic, not just what the code does, and shows before/after changes for clarity.

Core Features & Use Cases

  • Rationale-focused comments: Explain the why behind complex algorithms, regex patterns, and non-obvious decisions.
  • Diff-based updates: Apply comments and present before/after diffs to aid reviews.
  • Comment hygiene: Avoid commenting obvious code and mark workarounds with HACK/TODO tags.
  • Targeted guidance: Suitable for languages with inline comments in JavaScript, TypeScript, Python, and similar languages.

Quick Start

Run the inline-comments process on a source file to generate rationale-focused inline comments with a before/after diff.

Dependency Matrix

Required Modules

None required

Components

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: inline-comments
Download link: https://github.com/berkcangumusisik/claude-code-practices/archive/main.zip#inline-comments

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.