exploring-rust-crates

此技能为开发者提供了一套系统化的方法，用于在 HASH 开发环境中生成、检查与分析 Rust 软件包 (crate) 的说明文档。通过利用 cargo doc，它能将原始代码转化为可浏览的网页界面，帮助工程师快速绘制模块层级图，并理解复杂 Rust 套件的公开 API 接口。此工具专为加入 HASH monorepo 的开发者、进行内部套件重构的工程师，或是在处理需要深入理解 Trait Bounds 和关联类型 (Associated Types) 的调试场景时所设计。

• 使用 cargo doc 为特定套件或整个工作区生成完整的 HTML 说明文档。

• 呈现代码库中所有公开 API 的详细信息，包含函数、类型、Trait 与常量。

• 支持通过 --all-features 纳入功能标记 (feature-gated) 的 API，确保条件式代码的完整覆盖。

• 提供模块组织、组件关系与内部依赖结构的清晰视图。

• 通过文档中的 doctest 示例与错误处理模式，加速学习与开发效率。

• 执行说明文档指令时，可指定 --package 进行针对性分析，或使用 --workspace 进行全局分析。

• 建议使用 --no-deps 标志，将输出限制在本地源码范围内，以缩短构建时间并减少噪音。

• 生成的文档会存储于 target/doc 目录，index.html 是浏览器探索的主要入口点。

• 务必参考生成文档中的 # Examples 与 # Errors 章节，以掌握 HASH 内部的惯用 Rust 用法与错误传播模式。

• 请注意，生成文档属于编译阶段，请在执行指令前确认您的本地 Rust 工具链与环境变量已依照存储库设置说明完成配置。