Does it handle complex data structures and types?

Yes, it can define complex object types using @typedef in JSDoc or detailed type hinting and attribute descriptions in Python.

Which Python docstring styles are supported?

It follows standard Python docstring conventions compatible with popular documentation tools like Sphinx, Pdoc, and Doxygen.

Does this skill support TypeScript?

Yes, it provides full support for JSDoc and TypeScript-specific type definitions to ensure type safety is well-documented.

Can it generate usage examples within the documentation?

Absolutely. The skill includes @example tags and Python example blocks to demonstrate exactly how to implement your functions and classes.

Professional Code Documentation

Name: Professional Code Documentation
Author: aj-geddes

byaj-geddes

•

Aprendizaje y Documentación

Generates comprehensive, language-standard documentation including JSDoc, Python docstrings, and inline comments to improve code maintainability.

Acerca de

This skill empowers developers to maintain high-quality codebases by automatically generating or refining documentation across various programming languages. It adheres to industry-standard formats such as JSDoc for JavaScript/TypeScript, Google/NumPy styles for Python docstrings, and JavaDoc, ensuring that every function, class, and API endpoint is clearly explained with parameter types, return values, and usage examples. By standardizing documentation patterns, it makes code significantly more readable for teammates and reduces the overhead for long-term project maintenance.

Características Principales

18 GitHub stars
Detailed parameter, return type, and exception definitions
Practical code usage examples for functions and classes
Support for custom type definitions and asynchronous patterns
Language-specific standards (JSDoc, Python Docstrings, JavaDoc)
Clear inline commenting for complex logic blocks

Casos de Uso

Enforcing consistent documentation styles across large, multi-language software projects
Generating professional API documentation directly from source code comments
Documenting legacy codebases to improve developer onboarding and knowledge transfer

Acerca de

Características Principales

18 GitHub stars
Detailed parameter, return type, and exception definitions
Practical code usage examples for functions and classes
Support for custom type definitions and asynchronous patterns
Language-specific standards (JSDoc, Python Docstrings, JavaDoc)
Clear inline commenting for complex logic blocks

Casos de Uso

Enforcing consistent documentation styles across large, multi-language software projects
Generating professional API documentation directly from source code comments
Documenting legacy codebases to improve developer onboarding and knowledge transfer