writing-code-comments-and-docstrings
CommunityEnhance code clarity and maintainability.
Authorjeremydhoover-blip
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of writing clear, effective, and maintainable code documentation, ensuring that code is understandable by current and future developers.
Core Features & Use Cases
- Docstring Generation: Creates comprehensive docstrings for functions, classes, and modules following language-specific conventions (e.g., Google style for Python, JSDoc for TypeScript).
- Inline Comment Explanation: Provides explanatory comments for complex logic, non-obvious decisions, and workarounds.
- Annotation Support: Adds TODO, FIXME, HACK, and NOTE annotations with appropriate context and tracking information.
- Use Case: You've just implemented a complex algorithm in Python. Use this Skill to generate a detailed docstring explaining its parameters, return values, and potential exceptions, and add inline comments to clarify the tricky parts of the logic.
Quick Start
Use the writing-code-comments-and-docstrings skill to generate a Python docstring for the provided function.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 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: writing-code-comments-and-docstrings Download link: https://github.com/jeremydhoover-blip/hoover-content-system/archive/main.zip#writing-code-comments-and-docstrings 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 471,000+ vetted skills library on demand.