code-documentation-generator

Name: code-documentation-generator
Availability: InStock
Author: Nirbhay

Generate JSDoc, docstrings, and OpenAPI documentation across languages.

19|5|Updated Nov 23, 2025

Search Tags:#documentation #code generation #readme #jsdoc #api documentation #python docstrings

Ready to run

npx skills add https://github.com/Nir-Bhay/markups --skill code-documentation-generator

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-documentation-generator
Source: https://github.com/Nir-Bhay/markups/tree/main/.agents/skills/code-documentation-generator
Command: npx skills add https://github.com/Nir-Bhay/markups --skill code-documentation-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive and well-formatted documentation for various programming languages and API specifications, saving developers significant time and effort.

Core Features & Use Cases

JSDoc/Docstrings: Generates documentation comments for JavaScript, TypeScript, and Python code.
API Documentation: Creates documentation for REST APIs using OpenAPI/Swagger or Markdown formats.
README Templates: Provides templates for project README files.
Inline Comment Best Practices: Offers guidance on writing effective inline comments.
Automation Tools: Shows examples of using tools like TypeDoc and Sphinx for documentation generation.
Use Case: You have a new Python module and need to generate clear docstrings following Google style, including arguments, return values, and exceptions.

Quick Start

Use the code-documentation-generator skill to create JSDoc comments for the provided JavaScript function.

Frequently Asked Questions about code-documentation-generator

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

FAQPage Schema

How do I generate Python docstrings in Google or NumPy style?▼

To generate Python docstrings in Google or NumPy style, you can use this skill to automatically format arguments, return values, and exceptions. It creates comprehensive docstring comments tailored to your specific Python modules.

What is the best way to create JSDoc comments for JavaScript and TypeScript?▼

The best way to create JSDoc comments for JavaScript and TypeScript is to use an automated documentation generator. This skill formats standardized JSDoc annotations directly for your functions and modules.

Can I use Sphinx or TypeDoc to automate REST API documentation?▼

Yes, you can automate REST API documentation using tools like Sphinx and TypeDoc. This skill provides examples and templates for generating OpenAPI, Swagger, or Markdown formats for your APIs.

How do I write a project README with standard templates?▼

To write a project README with standard templates, this skill provides structured layouts for your repository. It generates comprehensive README files alongside inline comment best practices for your codebase.

Does this documentation generator support both inline comments and API specs?▼

Yes, this documentation generator supports both inline comments and API specs. It offers guidance on effective inline commenting alongside OpenAPI and Markdown generation for your REST API specifications.