New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Rust Doc Comment Generator

by mxsm in mxsm/rocketmq-rust

Generate idiomatic, production-grade Rust comments and documentation strictly following official Rustdoc and Rust API documentation conventions.

Apache-2.0Auto-check passedDevelopment

Install Rust Doc Comment Generator

skills CLI
$ npx skills add mxsm/rocketmq-rust --skill rust-doc-comment-generator -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install mxsm/rocketmq-rust rust-doc-comment-generator --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/mxsm/rocketmq-rust.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/rust-doc-comment-generator .claude/skills/rust-doc-comment-generator && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
rust-doc-comment-generator
GitHub stars
1.5k
Token cost
~1.1k tokens
SKILL.md length
373 words
Files
1
Skills in repo
6
Repo updated
First seen
Licence
Apache-2.0

At a glance

Generate idiomatic, production-grade Rust comments and documentation strictly following official Rustdoc and Rust API documentation conventions.

  • Works in 5 steps: Comment Types → Rustdoc Section Usage → Language & Tone → …
  • Tasks that involve Technical documentation
  • SKILL.md covers Overview, Standards & References, Supported Targets and Comment & Documentation Rules, plus 6 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Rust Doc Comment Generator is an agent skill from mxsm/rocketmq-rust. Generate idiomatic, production-grade Rust comments and documentation strictly following official Rustdoc and Rust API documentation conventions. Designed for real-world Rust projects with zero AI-identifiable markers.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. It works with Rust and Model Context Protocol. The repository describes itself as: 🚀 Apache RocketMQ built in Rust 🦀 — faster, safer, and more memory-efficient. Powering high-performance messaging for the AI era, with AI Agent, MCP, and AI-SRE capabilities. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/rust-doc-comment-generator”

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. Comment Types
  2. Rustdoc Section Usage
  3. Language & Tone
  4. Blocking vs Async Behavior
  5. Unsafe Code Documentation

What it can do on your machine

Read from SKILL.md and the folder at commit 13f7f5d. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are rust).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • doc.rust-lang.org
    • rust-lang.github.io

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Rust Doc Comment Generator loads about 1.1k tokens when it runs. Until then it costs about 61 tokens; SKILL.md has 373 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~61
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from mxsm/rocketmq-rust at commit 13f7f5d, republished under its Apache-2.0 licence (© mxsm). 373 words, ~1,062 tokens.

Download SKILL.mdSave it as .claude/skills/rust-doc-comment-generator/SKILL.md (or your agent's skills folder).
name
rust-doc-comment-generator
description
Generate idiomatic, production-grade Rust comments and documentation strictly following official Rustdoc and Rust API documentation conventions. Designed for real-world Rust projects with zero AI-identifiable markers.

Rust Documentation & Comment Generator Skill

Overview

This skill generates standard-compliant Rust comments and documentation for Rust source code. It strictly follows Rust’s official documentation guidelines and produces output suitable for production-quality open-source and enterprise Rust projects.

The generated comments are:

  • Idiomatic and precise
  • Free of AI-identifiable artifacts
  • Fully aligned with Rustdoc conventions
  • Suitable for blocking, async, and unsafe code

Standards & References

This skill MUST comply with the following authoritative sources:

Supported Targets

This skill applies to the following Rust items:

  • struct, enum, union
  • trait
  • impl blocks
  • fn / async fn
  • Modules (mod)
  • unsafe blocks and functions

Comment & Documentation Rules

1. Comment Types
ContextFormat
Public item/// Rustdoc comment
Module-level documentation//!
Private implementation detail//
Unsafe API explanation/// # Safety
2. Rustdoc Section Usage

Rustdoc sections MUST be included only when semantically relevant:

  • # Examples
  • # Panics
  • # Errors
  • # Safety
  • # Performance

Empty or boilerplate sections are not allowed.

3. Language & Tone
  • Use formal, neutral, technical language
  • Avoid conversational or instructional phrasing
  • Avoid marketing or subjective language
  • Describe behavior, constraints, and guarantees precisely

✅ Correct:

Represents the configuration used by the message consumer.

❌ Incorrect:

This struct is very useful and highly optimized.

4. Blocking vs Async Behavior
Blocking APIs

Blocking behavior MUST be explicitly documented.

rust
/// Blocks the current thread until a message is available.
Async / Non-Blocking APIs

Async behavior MUST be explicitly documented.

rust
/// Asynchronously waits for the next message.
///
/// This function does not block the calling thread.
Show full SKILL.md (155 more words)Show less
5. Unsafe Code Documentation

Any unsafe function or block MUST include a # Safety section.

rust
/// # Safety
///
/// The caller must ensure that the pointer is valid and properly aligned
/// for the duration of the call.

Vague or generic safety statements are forbidden.

Forbidden Content

The output MUST NOT contain:

  • Emojis
  • Phase or workflow markers (e.g. Phase, Step, Optimize)
  • TODO / FIXME / NOTE meta-comments
  • AI-related indicators or explanations
  • Commentary about refactoring or future improvements

Input Expectations

The user may provide:

  • Undocumented Rust code
  • Partially documented Rust code
  • Rust code with non-standard or low-quality comments

Output Expectations

The skill MUST:

  1. Preserve existing correct Rustdoc comments
  2. Rewrite non-standard comments into idiomatic Rustdoc
  3. Add missing documentation where appropriate
  4. Never change code semantics
  5. Never introduce new APIs or rename identifiers

Example

Input
rust
pub struct MessageQueue {
    capacity: usize,
}
Output
rust
/// Represents a bounded message queue.
///
/// The queue can store messages up to a fixed capacity.
pub struct MessageQueue {
    capacity: usize,
}

Non-Goals

This skill does NOT:

  • Refactor code
  • Optimize performance
  • Rename symbols
  • Add logging
  • Generate tests

Compatibility

This skill is designed to work alongside:

  • Rust API naming validation skills
  • Safety auditing skills
  • Project-specific glossary enforcement skills

Each skill operates independently and does not overlap responsibilities.

© mxsm, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/rust-doc-comment-generator of mxsm/rocketmq-rust.

Open the folder on GitHubat commit 13f7f5d

Compare with similar skills

Rust Doc Comment Generator next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Rust Doc Comment Generator compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Rust Doc Comment Generator this skillmxsm/rocketmq-rust1.5k—~1.1kAutomated safety check: PassApache-2.0
Alefxberg-io/alef100—~1.7kAutomated safety check: PassMIT
Library Documentation Seekerwithkynam/vibecode-pro-max-kit1.1k2 repos~1kAutomated safety check: NotesMIT
Deepwiki Rssopaco/deepwiki-rs3.1k—~748Automated safety check: PassMIT
Releasejaemk/self_update961—~2.2kAutomated safety check: PassMIT
tilth Code Reading CLIjahala/tilth352—~1.1kAutomated safety check: PassMIT

Similar skills

  • Alef

    xberg-io/alef

    Use Alef correctly for Rust-to-polyglot binding generation. An agent skill from xberg-io/alef.

    100 GitHub stars~1.7k tokensUpdated today
    DevelopmentAuto-check passed

  • Library Documentation Seeker

    withkynam/vibecode-pro-max-kit

    Looks up library and framework documentation through Context7 first, with bundled Node scripts as a fallback that fetch and analyze llms.txt files.

    1.1k GitHub starsUsed in 2 repos~1k tokens
    DevelopmentAuto-check: notes

  • Deepwiki Rs

    sopaco/deepwiki-rs

    AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation.

    3.1k GitHub stars~748 tokensUpdated 23 days ago
    DevelopmentAuto-check passed

  • Release

    jaemk/self_update

    Prepare a release (bump the crate version, update CHANGELOG.md with a migration guide for breaking changes, regenerate README, commit), or run a pre-release review.

    961 GitHub stars~2.2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

  • tilth Code Reading CLI

    jahala/tilth

    Replaces grep, cat, find and ls with the tilth CLI, which returns AST-aware outlines, definitions, usages and callers across many languages in one call.

    352 GitHub stars~1.1k tokensUpdated 10 days ago
    DevelopmentAuto-check passed

  • Rsigma

    timescale/rsigma

    Use the rsigma CLI and MCP server: engine eval, engine daemon, rule lint, rule draft, rule tune, rule backtest, backend convert, mcp serve.

    157 GitHub stars~1.2k tokensUpdated yesterday
    DevelopmentAuto-check passed

More from mxsm/rocketmq-rust

  • Rocketmq Rust Local Cluster

    mxsm/rocketmq-rust

    Set up, start, verify, inspect, and stop local development clusters from the current rocketmq-rust checkout.

    1.5k GitHub stars~2k tokensUpdated today
    Auto-check passed

  • Rocketmq Rust Issue Generator

    mxsm/rocketmq-rust

    A skill your agent uses when the user asks to create, draft, prepare, or publish a GitHub issue for the rocketmq-rust project — bugs, features, enhancements, refactors, docs, unit tests, CI…

    1.5k GitHub stars~1.6k tokensUpdated today
    Auto-check passed

  • Rocketmq Rust PR Submitter

    mxsm/rocketmq-rust

    A skill your agent uses when the user asks to prepare, submit, publish, or optimize a pull request for the rocketmq-rust project, especially when the PR title or commit message must follow the [ISSUE

    1.5k GitHub stars~1.4k tokensUpdated today
    Auto-check passed

  • Translate It Doc En Zh

    mxsm/rocketmq-rust

    Translate English IT and software engineering documents into professional, accurate Chinese.

    1.5k GitHub stars~1.2k tokensUpdated today
    Auto-check passed

  • Rocketmq Rust Good First Issue

    mxsm/rocketmq-rust

    Help the rocketmq-rust repository owner or maintainer prepare and publish good first issues for new contributors to claim, with exact files, concrete changes, acceptance criteria, labels, and…

    1.5k GitHub stars~2.3k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Rust Doc Comment Generator

What does Rust Doc Comment Generator do?

Generate idiomatic, production-grade Rust comments and documentation strictly following official Rustdoc and Rust API documentation conventions. Rust Doc Comment Generator is an agent skill from mxsm/rocketmq-rust. Generate idiomatic, production-grade Rust comments and documentation strictly following official Rustdoc and Rust API documentation conventions.

When should I use Rust Doc Comment Generator?

Rust Doc Comment Generator fits situations like: tasks that involve Technical documentation.

How do I install Rust Doc Comment Generator in Claude Code?

Run `npx skills add mxsm/rocketmq-rust --skill rust-doc-comment-generator -a claude-code`. Or copy the skill folder (.agents/skills/rust-doc-comment-generator in mxsm/rocketmq-rust) into .claude/skills/rust-doc-comment-generator in your project. Claude Code loads it when a task matches its description.

How do I install Rust Doc Comment Generator in Codex?

Run `npx skills add mxsm/rocketmq-rust --skill rust-doc-comment-generator -a codex`. Or copy the skill folder (.agents/skills/rust-doc-comment-generator in mxsm/rocketmq-rust) into .agents/skills/rust-doc-comment-generator in your project. Codex loads it when a task matches its description.

Can I use Rust Doc Comment Generator in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add mxsm/rocketmq-rust --skill rust-doc-comment-generator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/rust-doc-comment-generator, .gemini/skills/rust-doc-comment-generator, .github/skills/rust-doc-comment-generator and .opencode/skills/rust-doc-comment-generator in your project.

What does Rust Doc Comment Generator need to run?

SKILL.md names no scripts, command-line tools or credentials: Rust Doc Comment Generator is instructions for the agent only.

Does Rust Doc Comment Generator access the network?

SKILL.md names 2 domains. As links in the text: doc.rust-lang.org and rust-lang.github.io. This is read from the text; nothing was executed.

Is Rust Doc Comment Generator safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Rust Doc Comment Generator use?

Rust Doc Comment Generator is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Rust Doc Comment Generator use?

About 1.1k tokens (SKILL.md is roughly 4.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Rust Doc Comment Generator?

Skills that share tags, products or a category with Rust Doc Comment Generator: Alef (xberg-io/alef, 100 stars), Library Documentation Seeker (withkynam/vibecode-pro-max-kit, 1.1k stars), Deepwiki Rs (sopaco/deepwiki-rs, 3.1k stars) and Release (jaemk/self_update, 961 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Rust Doc Comment Generator?

mxsm (a GitHub user) maintains it in mxsm/rocketmq-rust, which has 1,524 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 7, 2026.

Source: mxsm/rocketmq-rust on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.