Skills
.Work. You
Rest

code-documentation-generator

Community

Generate high-quality code documentation.

Software Engineering#documentation#code generation#readme#jsdoc#api documentation#python docstrings
AuthorNir-Bhay
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: code-documentation-generator
Download link: https://github.com/Nir-Bhay/markups/archive/main.zip#code-documentation-generator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.