Code Documentation
Automatically generates clear, concise code documentation from Python functions and classes based on hainamchung's style.
Install on your platform
We auto-selected Claude Code based on this skill’s supported platforms.
Run in terminal (recommended)
claude mcp add hainamchung-code-documentation npx -- -y @trustedskills/hainamchung-code-documentation
Or manually add to ~/.claude/settings.json
{
"mcpServers": {
"hainamchung-code-documentation": {
"command": "npx",
"args": [
"-y",
"@trustedskills/hainamchung-code-documentation"
]
}
}
}Requires Claude Code (claude CLI). Run claude --version to verify your install.
About This Skill
What it does
This skill generates code documentation from existing source code. It can automatically create documentation files, including descriptions of functions and classes, based on comments within the code. The resulting documentation is designed to be clear, concise, and easily understandable for developers.
When to use it
- Automating repetitive tasks: Generate initial drafts of documentation for new projects or features, saving development time.
- Maintaining legacy codebases: Quickly create documentation for older code that lacks existing comments.
- Improving team onboarding: Provide clear and accessible documentation for new developers joining a project.
- Generating API references: Automatically produce comprehensive documentation for public APIs.
Key capabilities
- Generates documentation from source code comments.
- Supports multiple programming languages (specific languages not listed).
- Creates structured documentation files.
- Provides clear descriptions of functions and classes.
Example prompts
- "Generate documentation for this Python script: [paste code here]"
- "Create API reference documentation from the following Java class: [paste code here]"
- “Document all functions in this JavaScript file.”
Tips & gotchas
The quality of the generated documentation heavily relies on the clarity and completeness of comments within the source code. Ensure your code is well-commented for optimal results.
Tags
TrustedSkills Verification
Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.
Security Audits
| Gen Agent Trust Hub | Pass |
| Socket | Pass |
| Snyk | Pass |
🌐 Community
Passed automated security scans.