Skills
.Work. You
Rest

in-code-comments

Official

Write better code comments.

Software Engineering#code quality#documentation#clean code#maintainability#developer experience#comments
AuthorBluMintInc
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill addresses the common issue of poorly written or redundant in-code comments that hinder maintainability and understanding. It promotes comments that explain the 'why' behind code, not just the 'how'.

Core Features & Use Cases

  • Enforces 'Why, Not How': Guides AI to write comments that explain intent and design decisions, not just summarize code.
  • Contextual Clarity: Ensures comments provide information not evident from the code itself.
  • Avoids Redundancy: Prevents comments that merely restate code, reducing clutter and maintenance overhead.
  • A-temporal Writing: Promotes timeless, present-tense comments, avoiding outdated historical references.
  • Use Case: When generating code for a complex algorithm, this skill ensures comments explain the rationale behind specific optimizations or trade-offs, rather than just describing each line of code.

Quick Start

Use the in-code-comments skill to explain the reasoning behind the chosen algorithm in the provided code snippet.

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: in-code-comments
Download link: https://github.com/BluMintInc/eslint-custom-rules/archive/main.zip#in-code-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 223,000+ vetted skills library on demand.