docstring-generator
CommunityAuto-generate language docstrings for codebases.
Authordarellchua2
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automatically generates language-specific docstrings for Python, Java, TypeScript, and C# to ensure consistent, thorough documentation across codebases.
Core Features & Use Cases
- Language-aware docstring generation for Python (Google/NumPy/Sphinx), Java (Javadoc), TypeScript (JSDoc/TSDoc), and C# (XML documentation)
- Scope-aware coverage for functions, methods, classes, interfaces, properties, and exceptions
- PR-ready documentation enforcement and integration with linting/workflow checks
- Best-practices guidance for parameter, return, and exception documentation with usage examples
Quick Start
To generate docstrings for a target file, provide the file path and locate definitions, e.g., "generate_docstrings.py --path src/utils.py". The tool will insert appropriate docstrings directly after definitions following language conventions.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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: docstring-generator Download link: https://github.com/darellchua2/opencode-config-template/archive/main.zip#docstring-generator Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.