doc-comment-adder

Add or complete documentation comments to Rust and TypeScript code.

Updated Nov 8, 2025

Search Tags:#documentation #TypeScript #standards #code-quality #Rust #auto-generation #doc-comment

Ready to run

npx skills add https://github.com/10knamesmore/dotfiles --skill doc-comment-adder

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-comment-adder
Source: https://github.com/10knamesmore/dotfiles/tree/main/general/skills/doc-comment-adder
Command: npx skills add https://github.com/10knamesmore/dotfiles --skill doc-comment-adder

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of adding or completing documentation comments in Rust and TypeScript source files, ensuring consistent style and helpful documentation across a codebase.

Core Features & Use Cases

Automatically generate and insert documentation comments for modules, functions, structs/classes, fields, type aliases, enums, constants, and interfaces.
Supports Rust doc comments using /// and module-level comments using //!, and TypeScript docs using TSDoc style.
Use cases include onboarding new code, ensuring public APIs are documented, and retrofitting documentation without changing behavior.

Quick Start

Use the doc-comment-adder to process a target path, e.g. doc-comment-adder ./src/lib.rs or doc-comment-adder ./src/.

Frequently Asked Questions about doc-comment-adder

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

FAQPage Schema

How do I automatically generate doc comments for Rust and TypeScript files?▼

You can automatically generate doc comments by running this Skill against a target file or directory tree, which annotates modules, functions, and structs using Rust and TypeScript language conventions.

How do I add TSDoc comments to TypeScript functions and interfaces?▼

Adding TSDoc comments to TypeScript is handled by processing your source files to automatically generate and insert documentation for interfaces, classes, and functions according to TSDoc style guidelines.

Can I document an entire Rust codebase directory at once?▼

Yes, you can document an entire Rust codebase by targeting a directory tree, which allows the tool to recursively add module-level comments and doc comments across all matching source files.

Does adding doc comments overwrite my existing documentation?▼

Adding doc comments preserves existing documentation when present, ensuring your manually written comments remain intact while only completing missing annotations for modules, functions, and fields.

What is the best way to retrofit documentation without changing code behavior?▼

Retrofitting documentation without changing code behavior is achieved by automatically inserting standard doc comments into Rust and TypeScript files, ensuring public APIs are documented consistently.

Are there limitations when auto-generating Rust module comments?▼

Auto-generating Rust module comments relies on language specifications to guide creation, but the basic implementation depth means it focuses on standard structures like functions and enums rather than complex semantic analysis.