名称: 探索Rust包 描述: 生成Rust文档以理解包的API、结构和用法。适用于探索Rust代码、理解包组织、查找函数/类型/特征，或在HASH工作空间中需要了解Rust包上下文的情况。 许可证: AGPL-3.0 元数据: 触发器: 类型: 域 执行: 建议 优先级: 中 关键词: - cargo doc - rust文档 - 包api - rust包 - 模块层次 意图模式: - “\b(探索|理解|学习)\b.?\b(rust|包|包)\b" - "\b(什么|如何)\b.?\b(函数|类型|特征|api)\b.?\b包\b" - "\b文档(ation)?\b.?\brust\b”
探索Rust包
生成和使用Rust文档以理解HASH工作空间中包的API、结构和代码组织。
生成文档
针对特定包
cargo doc --no-deps --all-features --package <package-name>
针对整个工作空间
cargo doc --no-deps --all-features --workspace
关键标志
--no-deps: 仅文档本地代码（更快，噪音更少）--all-features: 包含所有功能门控的API--package <name>: 目标特定包--workspace: 文档工作空间中的所有包--document-private-items: 包含内部实现细节
生成的文档提供什么
- 包组织 - 模块层次和组件关系
- 公共API表面 - 所有公共函数、类型、特征和常量
- 使用示例 - 来自doctest块的代码示例
- 错误文档 - 记录错误条件和处理方式
- 类型关系 - 特征实现、类型别名、关联类型
查看文档
文档生成于：
target/doc/<crate_name>/index.html
提示
- 在深入研究不熟悉的Rust代码前生成文档
- 交叉参考
# Errors部分以了解错误处理模式 - 寻找
# Examples部分以了解惯用用法模式