skills.rest
luohaha
luohahaCOMMUNITY
Explore all skills by this author →
GitHub

code-commenter

Adds natural-language comments to code snippets and files, preserving the original formatting and unflagged bytes.

Updated Dec 24, 2025
Search Tags:#documentation#commenting#maintainability#multi-language#best-practices#code-review
One-click install
npx skills add https://github.com/luohaha/oh-my-skills --skill code-commenter
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-commenter
Source: https://github.com/luohaha/oh-my-skills/tree/main/skills/code-commenter
Command: npx skills add https://github.com/luohaha/oh-my-skills --skill code-commenter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide helps developers add high-quality comments that explain why code behaves as it does, capturing decisions, trade-offs, and context to improve maintainability and onboarding.

Core Features & Use Cases

  • Document rationale behind algorithms and decisions to aid future modifications.
  • Highlight edge cases, assumptions, and constraints that impact behavior.
  • Provide language-specific guidelines to ensure consistent, clear commenting across C++, Python, Java, JavaScript, Go, Rust, and SQL.

Quick Start

Provide a sample code snippet and annotate it with rationale and notes following these guidelines.

Frequently Asked Questions about code-commenter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add high-quality comments that explain why code works instead of just what it does?▼

To add high-quality code comments explaining why code works, document the rationale behind algorithms, decisions, and trade-offs. This captures surrounding context, edge cases, and constraints to improve maintainability and onboarding.

What is the best way to document code rationale for multi-language codebases?▼

The best way to document code rationale for multi-language codebases is to apply language-specific guidelines consistently across C++, Python, Java, JavaScript, Go, Rust, and SQL to ensure clear commenting across files, functions, and modules.

Does this code commenting approach work with C++, Python, Java, JavaScript, Go, Rust, and SQL?▼

Yes, this code commenting approach works with C++, Python, Java, JavaScript, Go, Rust, and SQL by providing language-specific guidelines to ensure consistent, clear commenting across these diverse multi-language codebases.

How do I document edge cases and constraints during code review or refactoring?▼

To document edge cases and constraints during code review or refactoring, add comments highlighting assumptions impacting behavior. This captures critical context and decisions to aid future modifications and team onboarding.

Related Skills

Explore More Software Engineering Skills→
frankxaifrankxai
6

arcanea-performance-tuning

Profile CPU, memory, I/O, and tracing to identify and eliminate performance bottlenecks.

Community
Advanced
dj-boltdj-bolt
1.6k

performance-optimization

Optimize Python and Rust code through profiling and algorithmic improvements.

Official
Advanced
muratcankoylanmuratcankoylan
8

BACKPRESSURE

Create deterministic self-verification checks for AI coding agents.

Community
Intermediate
masrurimzmasrurimz

doc-writer

Generate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.

Community
Basic