skills.rest
cornmanwtf
cornmanwtfCOMMUNITY
Explore all skills by this author →
GitHub

code-comment-enricher

Generate JSDoc or docstrings with usage examples for code files.

Updated Jan 16, 2026
Search Tags:#code quality#developer tools#documentation#code comments#jsdoc#docstrings
One-click install
npx skills add https://github.com/cornmanwtf/ABANG-COLEK --skill code-comment-enricher
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-comment-enricher
Source: https://github.com/cornmanwtf/ABANG-COLEK/tree/main/skills/documentation-knowledge/code-comment-enricher
Command: npx skills add https://github.com/cornmanwtf/ABANG-COLEK --skill code-comment-enricher

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of adding comprehensive JSDoc or docstrings to code, including practical examples, thereby improving code documentation quality and maintainability.

Core Features & Use Cases

  • Automated Documentation Generation: Generates JSDoc/docstrings for functions, classes, and modules.
  • Example Inclusion: Automatically creates relevant code examples to illustrate usage.
  • Use Case: When developing a new API endpoint, use this Skill to automatically generate detailed JSDoc comments for the handler function, including parameter descriptions, return types, and a usage example.

Quick Start

Use the code-comment-enricher skill to add JSDoc comments to the function defined in the file '/path/to/your/code.js'.

Frequently Asked Questions about code-comment-enricher

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

FAQPage Schema
How do I automatically generate JSDoc comments for JavaScript functions?▼

You can automatically generate JSDoc comments by providing your code files to this tool, which parses programming language syntax to create parameter descriptions, return types, and usage examples for functions and classes.

What is the best way to add docstrings with usage examples to an existing codebase?▼

The best way to add docstrings with usage examples is using an automated documentation generator that enriches existing code files, creating contextually relevant documentation for functions, classes, and modules to improve code clarity.

Can I use this tool to document API endpoint handler functions?▼

Yes, you can document API endpoint handler functions by generating detailed JSDoc comments that include parameter descriptions, return types, and practical usage examples for the handler.

Does automated JSDoc generation work without understanding the programming language syntax?▼

No, automated JSDoc generation requires an understanding of programming language syntax to parse the code files and generate accurate, contextually relevant documentation for the target functions and modules.

Why do I need to include usage examples in code docstrings?▼

Including usage examples in code docstrings improves code documentation quality and maintainability by providing clear, practical illustrations of how to use functions, classes, and modules in software development workflows.

Related Skills

Explore More Software Engineering Skills→
BarrettLoweBarrettLowe

code-docs

Generate conversational comments for functions, methods, and classes in C++ and Python.

Community
Basic
newkayak12newkayak12
1

code-documenter

Generate, format, and validate technical documentation including docstrings and OpenAPI specs.

Community
Intermediate
HomericIntelligenceHomericIntelligence
18

quality-run-linters

Run Mojo format, markdownlint, and pre-commit hooks for code quality checks.

Official
Intermediate
mymx2mymx2
4

repowiki

Generate Mermaid-integrated Markdown documentation from repository architecture analysis.

Community
Advanced