SuperAPI AI 工具集

exploring-rust-crates

编程与开发

查看项目

更新于 10-15 22:12

技能介绍

用途:在 HASH 工作区中生成 Rust 文档,帮助理解 crate 的 API、结构、模块组织与用法,适合在深入阅读不熟悉的 Rust 代码前使用。

主要能力:生成的文档可展示 crate 组织(模块层级与组件关系)、公开 API 表面(公开函数、类型、trait、常量)、用法示例(来自 doctest 代码块)、错误文档(已记录的错误条件与处理方式)以及类型关系(trait 实现、类型别名、关联类型)。

使用方式:为特定包生成文档使用 cargo doc --no-deps --all-features --package <package-name>;为整个工作区生成使用 cargo doc --no-deps --all-features --workspace。关键参数:--no-deps 仅文档化本地代码(更快、噪音更少);--all-features 包含所有受 feature 控制的 API;--package <name> 指定某个 crate;--workspace 文档化工作区中所有 crate;--document-private-items 包含内部实现细节。文档生成位置为 target/doc/<crate_name>/index.html。

适用场景:探索 Rust 代码、理解 crate 组织、查找 API 与用法示例时。

限制与提示:资料未提供其他平台、收费或效果信息;建议先生成文档再阅读代码,并交叉参考 # Errors 与 # Examples 部分了解错误处理与惯用写法。