如何为私有项目生成文档

Question

9

我有一个项目，其中包括：

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

当我运行时，我只能得到main.rs的文档，而不能得到模块的文档。

在我的main.rs文件中，我有：

mod module_1;
mod module_2;

fn main() {
...
}

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

但我在 rustdoc 的帮助文档中找不到如何操作的说明。

有人可以为我解释一下吗？

- bubulemaster

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- mcarton · Accepted Answer

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

自Rust 1.29.0起，cargo doc支持--document-private-items，以记录私有项。

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