Does it support modern type hints and declarations?

Absolutely. It incorporates type information from code signatures directly into docstrings for Python and JSDoc for TypeScript/JavaScript.

Can this skill help with generating API documentation?

Yes, it is designed to generate comprehensive API documentation that focuses on clarity, completeness, and adherence to language standards.

Can it generate usage examples for my functions?

Yes, the skill analyzes your code structure to provide helpful usage examples within the generated documentation block.

Which programming languages are supported?

The skill currently supports Python (Google, NumPy, and Sphinx styles), JavaScript/TypeScript (JSDoc), Go, and Java (JavaDoc).

Will it add comments inside my function bodies?

Yes, in addition to header docstrings, the skill adds inline comments to explain complex logic or non-obvious implementation details.

Professional Code Documentation

Name: Professional Code Documentation
Author: lexicalninja

bylexicalninja

0•

학습 및 문서화

Generates comprehensive, language-specific docstrings and inline comments to improve code maintainability and clarity.

The Code Documentation skill empowers developers to maintain high-quality codebases by automatically generating structured documentation tailored to specific programming language standards. It analyzes function signatures, logic, and types to produce accurate docstrings for Python, JSDoc for JavaScript/TypeScript, and standard comments for Go and Java. By automating the creation of parameter descriptions, return values, and usage examples, it ensures your code remains readable and professional, making it an essential tool for documenting legacy code or preparing APIs for public consumption.

주요 기능

01Supports multiple language standards including Python, JS/TS, Go, and Java

02Automatically identifies parameters, return types, and potential exceptions

03Adds intelligent inline comments for non-obvious logic blocks

04Generates structured docstrings in Google, NumPy, JSDoc, and JavaDoc formats

05Creates helpful usage examples and edge case notes for complex functions

060 GitHub stars

사용 사례

01Modernizing legacy codebases that lack consistent documentation

02Generating professional API documentation for external developer use

03Standardizing docstring formats across a diverse multi-language repository

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add lexicalninja/my-little-scrum-team code-documentation

For use in Claude.ai and ChatGPT

Download Skill