Skills
.Work. You
Rest

add-code-comments

Community

Improve Go code self-documentation without altering logic.

Software Engineering#documentation#commenting#go#static-analysis#exported-symbols
Authoreasyspace-ai
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill reviews a Go codebase and automatically adds missing documentation comments to exported types, functions, methods, and constants, while inserting clarifying inline notes for non-trivial logic, to improve code readability and maintainability.

Core Features & Use Cases

  • Automated comment augmentation: Adds missing Go doc comments following standard conventions.
  • Inline explanatory notes: Documents complex conditionals, concurrency, and design choices to illuminate intent.
  • Bug discovery logging: If a potential bug or risky pattern is found, records an entry in BUGS.md for later review without changing code.
  • Non-destructive: Only comments are added; no code changes, imports, or reformatting.

Quick Start

Run the skill to scan all Go packages and add documentation comments to exported symbols.

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: add-code-comments
Download link: https://github.com/easyspace-ai/minote/archive/main.zip#add-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 471,000+ vetted skills library on demand.