rustdoc 手册

译文 · 基于 The rustdoc book

rustdoc 手册

原文链接: https://doc.rust-lang.org/rustdoc/

本手册介绍 Rust 发行版自带的文档生成工具 rustdoc：如何生成文档、如何阅读生成结果，以及如何编写高质量的 Rust 文档。

章节

rustdoc 是什么？

rustdoc 简介、基本用法，以及与 Cargo 的配合。

命令行参数

rustdoc 可用的命令行参数参考。

如何阅读 rustdoc 输出

阅读生成文档的界面，包括文档内设置与搜索。

如何编写文档

文档应写什么、#[doc] 属性、重导出、按名链接与文档测试。

rustdoc 专用 lint

rustdoc 提供的文档相关 lint。

抓取示例

从项目中抓取示例并展示在文档中。

高级特性

主题、静态资源等高级功能。

不稳定特性

仅在 nightly 可用的 rustdoc 特性。

已弃用特性

已弃用、请勿再使用的特性。

参考资料

相关官方文档与链接。