优秀的 rustdoc

此项目展示了如何使用 rustdoc 编写文档。要开始，运行 cargo doc --open 并按照说明进行。

此项目是 Rust Berlin 线上 Meetup 的一部分。

lib.rs:

rustdoc 是什么？

rustdoc 是将 Rust 代码转换为文档的工具。它可以独立使用，但您可能更希望从 cargo 中调用它

cargo doc --open

上述命令会生成文档并在浏览器中打开。

为什么要使用 rustdoc？

大多数公开的代码都需要关于如何使用它的文档。虽然 rustdoc 可以通过自身生成大量文档，但仍然需要人类提供额外的信息。

如何使用 rustdoc？

您可以在源代码中添加特殊的文档注释。如果您想要为模块编写文档，您需要插入以 //! 开始的文档行来描述模块文件本身。您可以通过单击页面右上角的“源”链接来查看此模块的完成方式。

了解更多

查看 [codeblocks] 模块。