rust - 如何为私有(private)元素生成文档

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

这是因为这些模块是私有(private)的，并且默认行为是仅记录公共(public)成员。

截至Rust 1.29.0 , cargo doc支持--document-private-items , 记录私有(private)元素。

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