skills.rest
dhruvinrsoni
dhruvinrsoniCOMMUNITY
Explore all skills by this author →
Website𝕏@dhruvinrsoniGitHub

inline_documentation

Generate JSDoc, docstrings, and type annotations for code files.

Updated Feb 3, 2026
Search Tags:#code quality#documentation#maintainability#code comments#jsdoc#docstrings
One-click install
npx skills add https://github.com/dhruvinrsoni/agentskills-garden --skill inline-documentation-dhruvinrsoni
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: inline_documentation
Source: https://github.com/dhruvinrsoni/agentskills-garden/tree/main/skills/50-documentation/inline-documentation
Command: npx skills add https://github.com/dhruvinrsoni/agentskills-garden --skill inline-documentation-dhruvinrsoni

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of unclear, missing, or outdated inline code documentation, making software more understandable and maintainable.

Core Features & Use Cases

  • Automated Docstring Generation: Creates JSDoc, Python docstrings, and more for functions and classes.
  • Comment Quality Audit: Identifies and suggests improvements for redundant, stale, or noisy comments.
  • Use Case: Improve the maintainability of a legacy Python codebase by automatically generating docstrings for all public functions, explaining their parameters and return values.

Quick Start

Use the inline_documentation skill to generate documentation for the files in the 'src/' directory.

Frequently Asked Questions about inline_documentation

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

FAQPage Schema
How do I automatically generate JSDoc and docstrings for existing code?▼

Automated docstring generation analyzes functions and classes to create JSDoc, Python docstrings, and type annotations. This improves code clarity and maintainability across multiple languages by making existing code self-documenting.

How do I find and fix stale or redundant code comments?▼

A comment quality audit identifies and rectifies documentation anti-patterns such as redundancy, staleness, and untracked TODOs. It suggests targeted improvements to ensure your inline comments remain accurate and useful.

What is the best way to add inline documentation to a legacy codebase?▼

The best way to document a legacy codebase is to scan source files and automatically generate public function docstrings explaining parameters and return values. This enhances code clarity and improves overall maintainability.

Can I generate type annotations and inline documentation for multiple programming languages?▼

Yes, this inline documentation generation supports multiple programming languages and documentation styles. It analyzes your code to produce appropriate type annotations and inline comments tailored to each language's conventions.

Why does my code documentation include untracked TODOs and anti-patterns?▼

Code documentation accumulates anti-patterns like untracked TODOs, staleness, and redundancy over time. A comment quality audit detects these issues and rectifies them to restore documentation accuracy and code clarity.

Related Skills

Explore More Software Engineering Skills→
spencerbeggsspencerbeggs

user-docs-detect-shape

Analyze repository file structures to determine project type and technical metadata.

Community
Intermediate
nguyenphpnguyenphp
41

lint-and-validate

Run linters, type checkers, and security audits across Node.js and Python projects.

Community
Intermediate
sho7650sho7650

refactor

Refactor code with extract, inline, rename, restructure, and simplify strategies.

Community
Advanced
tomique34tomique34
8

api-docs-generator

Generate Markdown API documentation from OpenAPI specs, Python docstrings, and JSDoc/TSDoc comments.

Community
Advanced