rust - 通过 Cargo 生成文档时如何包含私有(private)模块？

Question

我目前正在使用 Rust 和 Cargo 开发一个项目。它运行良好，但我遇到了一个小问题:为了代码重用，我的大部分项目都在一个 lib crate 中。在这个箱子里，很多东西都是私有(private)的。所以当我做 cargo doc 时，我只有公开的、导出的东西的文档......这实际上很棒，因为很容易看出什么是导出的，什么不是。

但我不得不承认:我错过了整个项目的完整文档，用于开发目的......

Answer 1

Rust 1.41

二进制文件的文档默认包括二进制包中的私有(private)项。

Rust 1.29

您现在可以使用 cargo doc --document-private-items

以前的版本

今天你可能无法使用 Cargo 来完成，如果你直接使用 rustdoc 有一个解决方法。

运行 cargo doc -v 并记下它运行的 rustdoc 命令:

$ cargo doc -v
   Compiling docz v0.0.1 (file:///private/tmp/docz)
     Running `rustdoc src/lib.rs -o /private/tmp/docz/target/doc --crate-name docz -L dependency=/private/tmp/docz/target/debug -L dependency=/private/tmp/docz/target/debug/deps`

然后，将--no-defaults --passes strip-hidden --passes collapse-docs --passes unindent-comments添加到命令中:

rustdoc src/lib.rs -o /private/tmp/docz/target/doc --crate-name docz \
    -L dependency=/private/tmp/docz/target/debug \
    -L dependency=/private/tmp/docz/target/debug/deps \
    --no-defaults \
    --passes strip-hidden --passes collapse-docs --passes unindent-comments