skills.rest
rp1-run
rp1-runOFFICIAL
Explore all skills by this author →
WebsiteGitHub

code-comments

Extract comment locations from git-scoped code changes into a structured JSON manifest.

38|8|Updated Nov 30, 2025
Search Tags:#git#documentation#analysis#comments#code#extract
One-click install
npx skills add https://github.com/rp1-run/rp1 --skill code-comments
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-comments
Source: https://github.com/rp1-run/rp1/tree/main/plugins/base/skills/code-comments
Command: npx skills add https://github.com/rp1-run/rp1 --skill code-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Extracts comment locations from code to help auditing and improving documentation coverage.

Core Features & Use Cases

  • Detects changed files in a git scope and extracts comments with line numbers and context
  • Supports multiple languages

Quick Start

Run extract_comments.py to pull comments from the current changed files.

Frequently Asked Questions about code-comments

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

FAQPage Schema
How do I extract comments from changed code files in git?▼

Extract comments from git-scoped changes by running the extraction tool, which detects modified files and pulls all comments with line numbers, types, and context into structured JSON output for analysis across multiple languages.

What information does comment extraction provide about my code?▼

Comment extraction produces a structured manifest containing file paths, line numbers, comment type, content, and surrounding code context, enabling auditing, documentation coverage analysis, and pattern detection across your codebase.

Can I extract comments from multiple programming languages?▼

Yes, the extraction tool supports multiple languages and handles language-specific comment patterns, automatically detecting and processing syntax variations to extract comments consistently across your codebase.

How can I use extracted comments for documentation auditing?▼

Use the structured JSON manifest of extracted comments to audit documentation coverage, identify outdated or missing comments, detect comment patterns, and prioritize cleanup or improvement efforts across files and teams.

What are the limitations when extracting comments from large codebases?▼

Comment extraction enforces size limits and includes error handling for edge cases to ensure efficient processing. Check the output for any unprocessed files or warnings when working with very large repositories.

Related Skills

Explore More Software Engineering Skills→
pigfootpigfoot
5

commit

Generate conventional Git commits with emoji prefixes and GPG signing.

Community
Advanced
bitsoexbitsoex
40

coderabbit-workflow

Manage CodeRabbit review workflows via CLI scripts and PR comment processing.

Official
Advanced
dirnbauerdirnbauer
33

document-processing

Create, extract from, and analyze PDF, DOCX, PPTX, and XLSX office documents using Python and JavaScript libraries.

Community
Advanced
ckrono-progckrono-prog

security_scan

Conducts a multi-scanner security audit of a codebase for critical and high vulnerabilities.

Community
Intermediate