Verified:GitHub

Qdoc-comment

Detect project language and insert documentation comments for undocumented public APIs.

6|Updated Mar 14, 2026

Search Tags:#typescript #documentation #python #rust #java #code-quality #comment

One-click install

npx skills add https://github.com/inho-team/qe-framework --skill qdoc-comment

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: Qdoc-comment
Source: https://github.com/inho-team/qe-framework/tree/main/skills/Qdoc-comment
Command: npx skills add https://github.com/inho-team/qe-framework --skill qdoc-comment

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically detects a project's language and adds missing documentation comments to public APIs, improving code understandability without manual annotation.

Core Features & Use Cases

Language-aware comment insertion across Java (JavaDoc), Python (docstrings), TypeScript/JavaScript (TSDoc/JSDoc), Go (godoc), Kotlin (KDoc), and Rust (rustdoc).
Preserves existing comment styles and avoids overwriting existing comments to maintain consistency.
Use Case: rapidly bring consistent inline documentation to a large codebase without modifying code behavior.

Quick Start

Analyze a codebase and run the skill to annotate all undocumented public members with language-appropriate documentation.

Frequently Asked Questions about Qdoc-comment

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automatically generate inline documentation comments for public APIs in multiple programming languages?▼

This tool detects the project language and inserts language-appropriate inline documentation comments like Javadoc, docstrings, or TSDoc directly into undocumented public APIs.

How do I add missing docstrings and Javadoc to a large codebase without overwriting existing comments?▼

Adding missing docstrings and Javadoc without overwriting existing comments is achieved by a non-destructive mechanism that preserves current comment styles and writes only to undocumented public members.

Does automatic code documentation generation work with both Python and Rust?▼

Yes, automatic code documentation generation works with both Python and Rust, supporting Python docstrings and Rustdoc comments along with Java, TypeScript, Go, and Kotlin formats.

What is the best way to quickly document all undocumented public members across a multi-language codebase?▼

The best way to quickly document undocumented public members across a multi-language codebase is to run an automated language-aware annotation skill that generates consistent comments without modifying code behavior.

Will adding inline code comments automatically alter my code's execution behavior?▼

No, adding inline code comments automatically will not alter your code's execution behavior because the process operates in a strictly non-destructive manner by only writing documentation comments.

Can I automatically insert TypeScript TSDoc comments for undocumented public APIs?▼

Yes, you can automatically insert TypeScript TSDoc comments for undocumented public APIs because the tool detects TypeScript and JavaScript projects to generate appropriate inline documentation.