2.10. 为 Rust 项目构建文档


使用 Cargo 工具,从标记为提取的源代码中的注释生成文档。请注意,文档注释仅针对公共功能、变量和成员提取。

流程

  1. 在您的代码中,在行首使用三斜杠 /// 来标记行以提取文档的注释。
  2. 构建文档:

    $ cargo doc --no-deps
    Copy to Clipboard Toggle word wrap

    命令将生成的文档存储在 .target/doc/ 目录中。

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat