2.10. 为 Rust 项目构建文档

先决条件

• 构建的 Rust 项目。
  有关如何构建 Rust 项目的详情，请参考 构建 Rust 项目。
• 配置的依赖关系。
  有关配置依赖项的更多信息，请参阅配置 Rust 项目依赖项。

流程

• 要标记提取的注释，请使用三个斜杠 ///，并将您的注释放在文档所在行的开头。
  cargo 支持您的评论的 Markdown 语言。

• 要使用 Cargo 构建项目文档，请在项目目录中运行：

  • 在 Red Hat Enterprise Linux 7 上：

    $ scl enable rust-toolset-1.62 'cargo doc --no-deps'

    Copy to Clipboard Toggle word wrap

  • 在 Red Hat Enterprise Linux 8 中：

    $ cargo doc --no-deps

    Copy to Clipboard Toggle word wrap

  • 在 Red Hat Enterprise Linux 9 中：

    $ cargo doc --no-deps

    Copy to Clipboard Toggle word wrap