exploring-rust-crates

此技能通过使用 cargo doc 提供自动化文档生成，协助开发人员深入了解 HASH 的 Rust 代码库。它专为需要快速掌握新 crate 架构、识别公共 API 接口或理解复杂类型层次的工程师而设计。透过此工具，您可以生成详细的 HTML 文档，勾勒工作区内的模块边界与依赖关系，从而深入理解各组件间的交互方式。

• 自动执行带有 --no-deps 与 --all-features 等优化参数的 cargo doc，实现高效且相关的文档生成。

• 提供明确的本地文档访问路径（位于 target/doc/index.html）。

• 突出显示关键的 API 表面，包括公共函数、Trait、常量与类型别名。

• 支持研究 Trait 实现、关联类型与模块层次结构。

• 透过交叉参考记录的错误条件，协助研究错误处理模式。

• 当您遇到陌生的 Rust 套件或需要理解 HASH 工作区的结构组织时，请使用此技能。

• 在开始深度重构任务前，请务必生成文档，以确保清楚掌握内部实现细节，亦可选择使用 --document-private-items。

• 参考 doctest 区块中的代码范例，学习 HASH 特定 crate 的惯用写法。

• 请注意，文档生成是针对工作区设计的；您可以使用 --package 指定特定 crate，或一次性生成整个工作区的文档。

• 请注意生成的档案会放置在 target 目录中；若未使用 --no-deps，请确保在大规模依赖图中拥有足够的磁盘空间。

• 此工具专为 HASH 内的 Rust 开发工作流量身打造，并假设开发环境已正确配置 cargo 与 Rust 工具链。