如何生成私人物品的文档

Question

我有一个项目，其中：

main.rs
module_1/mod.rs
module_2/mod.rs
module_2/module_3/mod.rs

运行cargo doc时，我只有main.rs的文档，而没有模块的文档。

在我的main.rs中，我有：

mod module_1;
mod module_2;

fn main() {
...
}

我尝试使用///或//!来记录模块。

我在rustdoc的帮助中找不到该怎么做的。

有人可以解释我吗？

Answer 1

这是因为这些模块是私有的，默认行为是仅记录公共成员。

从Rust 1.29.0开始，cargo doc支持--document-private-items，以记录私人物品。

在1.29之前，rustdoc已经支持标志--document-private-items，这意味着您可以使用cargo rustdoc -- --document-private-items为项目生成文档。但是cargo doc不支持该标志。