Skills
.Work. You
Rest

commenting-code

Official

Write better code comments.

Software Engineering#code review#documentation#python#maintainability#code comments#docstrings
Authorothercode
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps developers write more effective code comments and docstrings by distinguishing between useful and redundant documentation, leading to cleaner, more maintainable codebases.

Core Features & Use Cases

  • Comment Quality Assessment: Identifies and suggests removal of comments that merely restate code functionality.
  • Docstring Best Practices: Enforces the use of docstrings for explaining the "why" behind code, documenting interfaces, and providing UI-specific information (like help_text).
  • Use Case: When reviewing a pull request, this Skill can flag comments that are redundant, helping the author to remove them and focus on documentation that adds real value.

Quick Start

Use the commenting-code skill to review the docstrings and comments in the current Python file.

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: commenting-code
Download link: https://github.com/othercode/profiles/archive/main.zip#commenting-code

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.