rust - 如何为私人物品生成文档

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() {
...
}

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

我在 's 帮助中找不到rustdoc如何做到这一点。

有人可以解释一下吗？

标签： rustrust-cargorustdoc

Answer 1

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

从Rust 1.29.0 开始，cargo doc支持--document-private-items, 来记录私有项目。

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