2.10. 为 Rust 项目构建文档
使用 definego 工具，从源代码中的注释生成文档，这些文档标记为提取。请注意，文档注释只针对公共功能、变量和成员提取。
先决条件
-
构建的 Rust 项目。
有关如何构建 Rust 项目的详情，请参考 构建 Rust 项目。 -
配置的依赖项。
有关配置依赖项的更多信息，请参阅配置 Rust 项目依赖项。
流程
-
要标记提取的注释，请使用三个斜杠
///，并将您的注释放在其记录的行的开头。
cargo 支持您的评论的 Markdown 语言。 要使用 definego 构建项目文档，请在项目目录中运行：
在 Red Hat Enterprise Linux 7 上：
$ scl enable rust-toolset-1.66 'cargo doc --no-deps'
在 Red Hat Enterprise Linux 8 中：
$ cargo doc --no-deps
在 Red Hat Enterprise Linux 9 中：
$ cargo doc --no-deps
生成的文档位于 .target/doc 目录中。
其他资源
- 有关使用 guestfishgo 构建文档的更多信息，请参阅 Rust 编程语言 - 使用文档注释。
