skills.rest
michsindlinger
michsindlingerCOMMUNITY
Explore all skills by this author →
GitHub

code-documentation

Generates inline comments, docstrings, type hints, and annotations for Ruby, JavaScript/TypeScript, and Python code.

1|Updated Aug 10, 2025
Search Tags:#code quality#developer tools#code analysis#documentation#maintainability#type hints#docstrings
One-click install
npx skills add https://github.com/michsindlinger/agent-os-extended --skill code-documentation-michsindlinger
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/michsindlinger/agent-os-extended/tree/main/agent-os/templates/skills/dev-team/documenter/code-documentation
Command: npx skills add https://github.com/michsindlinger/agent-os-extended --skill code-documentation-michsindlinger

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of maintaining codebases by ensuring comprehensive inline documentation, making complex code understandable and maintainable for future developers.

Core Features & Use Cases

  • Comprehensive Documentation: Adds inline comments, docstrings, type hints, and annotations to code.
  • Multi-language Support: Provides specific guidance for Ruby, JavaScript/TypeScript, and Python.
  • Use Case: After implementing a new feature in a Java Spring Boot application, use this Skill to automatically generate detailed Javadoc comments for all public methods and classes, ensuring clarity for the team.

Quick Start

Use the code-documentation skill to add inline documentation to the file '/src/utils/helpers.js'.

Frequently Asked Questions about code-documentation

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

FAQPage Schema
How do I generate inline documentation and type hints for existing code?▼

Generate inline documentation and type hints by analyzing code to automatically add comments, docstrings, and annotations. This clarifies complex logic and business rules, making your codebase self-documenting and maintainable.

What is the best way to add docstrings and comments to a JavaScript file?▼

The best way to add docstrings and comments to JavaScript is using multi-language code analysis. It automatically generates inline documentation and annotations tailored to JavaScript conventions, clarifying API usage and complex logic.

Does this code documentation tool support Python and Ruby type hints?▼

Yes, this code documentation tool supports Python and Ruby. It provides language-specific conventions for generating comprehensive inline documentation, including type hints, annotations, and docstrings for these languages.

Can I automatically generate Javadoc comments for Java Spring Boot public methods?▼

You can automatically generate detailed Javadoc comments for public methods and classes in Java Spring Boot applications. This ensures clarity and maintains code quality for your development team after implementing new features.

When do I need to add type hints and annotations to my codebase?▼

You need to add type hints and annotations when maintaining codebases with complex logic and business rules. Comprehensive inline documentation makes code understandable for future developers and facilitates long-term maintainability.

Related Skills

Explore More Software Engineering Skills→
Mekann2904Mekann2904

doc-generator

Generate API documentation from source code using JSDoc, Sphinx, Doxygen, and OpenAPI.

Community
Intermediate
peteski22peteski22
22

validate-python-style

Validate Python code for Google-style docstrings, modern type hints, and architecture.

Community
Intermediate
ianyimiianyimi
1

Global Coding Style

Enforce global coding style guidelines across multi-language codebases.

Community
Basic
miounet11miounet11

Doc Generator

Generate and improve code documentation across JSDoc, README, and API specs.

Community
Intermediate