如何为私有项目生成文档

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

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

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

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

How to generate documentation for private items