跳转到主要内容

writing-comments

星标76
分支9
更新时间2026年7月20日 20:17

How to write inline (//), rustdoc item (///), and module (//!) comments in the compiler-rs codebase, plus JSDoc in the TypeScript wrapper — for contributors reading the source, not end users. Use whenever writing or editing comments in Rust or TypeScript source, including comments added incidentally while fixing a bug or building a feature.

· 实时索引

安装

用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。

想先保存到本地?可下载 RuleHub 当前索引到的 GitHub 仓库压缩包。

下载 Zip
文件资源管理器2 个文件
SKILL.mdreadonly
namewriting-comments
descriptionHow to write inline (//), rustdoc item (///), and module (//!) comments in the compiler-rs codebase, plus JSDoc in the T...

writing-comments

How to write inline (//), rustdoc item (///), and module (//!) comments in the compiler-rs codebase, plus JSDoc in the TypeScript wrapper — for contributors reading the source, not end users. Use whenever writing or editing comments in Rust or TypeScript source, including comments added incidentally while fixing a bug or building a feature.

When to use

Use this skill when the user needs help with tasks related to writing comments.

Guidelines

  • Follow repository conventions in withastro/compiler-rs
  • Prefer minimal, focused changes
  • Validate outputs before finishing