skills.rest
duwenji
duwenjiCOMMUNITY
Explore all skills by this author →
GitHub

doc-generator

Generate docstrings for functions, methods, and classes in multiple languages and styles.

Updated Mar 7, 2026
Search Tags:#typescript#documentation#python#code generation#javascript#go#java#docstring
One-click install
npx skills add https://github.com/duwenji/github-copilot-skills-tutorial --skill doc-generator-duwenji
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/duwenji/github-copilot-skills-tutorial/tree/main/samples/doc-generator
Command: npx skills add https://github.com/duwenji/github-copilot-skills-tutorial --skill doc-generator-duwenji

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of documentation (docstrings) for code elements like functions, methods, and classes, saving developers significant time and ensuring consistent documentation quality.

Core Features & Use Cases

  • Multi-language Support: Works with Python, JavaScript, TypeScript, Java, and Go.
  • Multiple Docstyle Formats: Supports Google, NumPy, Sphinx, JSDoc, JavaDoc, and GoDoc styles.
  • Configurable Detail Level: Allows users to specify the verbosity of the generated documentation.
  • Use Case: A developer needs to document a complex Python function. They provide the function signature and specify the 'Google' docstyle, and the Skill generates a well-formatted docstring including arguments, return values, and potential exceptions.

Quick Start

Generate a Google-style docstring for the provided Python function definition.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I automatically generate Python docstrings for functions and classes?▼

To automatically generate Python docstrings, you provide the function or class signature and specify a style like Google, NumPy, or Sphinx. The tool then outputs formatted documentation including arguments, returns, and exceptions.

Can I generate JSDoc comments for JavaScript and TypeScript code?▼

Yes, you can generate JSDoc comments for JavaScript and TypeScript code. By providing the function or method definition, the tool automatically formats the documentation according to JSDoc standards.

What is the best way to create GoDoc and JavaDoc documentation from code?▼

The best way to create GoDoc and JavaDoc documentation is to input your Go or Java code elements and let the generator apply the specific formatting rules for each language, ensuring consistent documentation quality.

How do I control the verbosity when generating code documentation?▼

You can control the verbosity of generated code documentation by specifying a configurable detail level. This allows you to determine whether the output includes just a summary or full details like arguments, returns, and examples.

Does automatic docstring generation work across multiple programming languages?▼

Automatic docstring generation works across multiple programming languages including Python, JavaScript, TypeScript, Java, and Go. It adapts to the specific documentation style required by each language automatically.

Related Skills

Explore More Software Engineering Skills→
dxpfigdxpfig

Analyzing AgentScope Library

Extract AgentScope module signatures, class and function definitions, and docstrings.

Community
Intermediate
Design-System-ETDesign-System-ET

code-documenter

Generate docstrings, API specifications, and developer guides for Python, TypeScript, and JavaScript.

Official
Advanced
maslennikov-igmaslennikov-ig
2

code-reviewer

Automate pull-request code review across six languages with structured reports.

Community
Advanced
AndyMarigoldLabsAndyMarigoldLabs

code-explainer

Explain complex code with audience-specific walkthroughs and documentation templates.

Community
Basic