Rust 通过 Cargo 生成文档时如何包含私有模块

发布于04月01日

我目前正在做一个关于铁 rust 和Cargo 的项目.它工作得很好，但我遇到了一个小问题:对于代码重用，我的大多数项目都在一个lib crate 中.在这个箱子里，很多东西都是私有的.所以当我做cargo doc次的时候，我只有公开的，导出的文件...这其实很好，因为很容易看到什么是出口的，什么不是.

但我必须承认:为了开发目的，我错过了整个项目的完整文档...

Rust 1.41

默认情况下，二进制文件的文档包括二进制文件箱中的私有物品.

Rust 1.29

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

Previous versions

今天你可能无法处理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

Rust相关问答推荐

Rust 通过 Cargo 生成文档时如何包含私有模块

推荐答案

Rust 1.41

Rust 1.29

Previous versions

Rust相关问答推荐

在没有引用计数或互斥锁的情况下，可以从Rust回调函数内的封闭作用域访问变量吗？

下载压缩文件

为什么我可以跟踪以前borrow 过的变量？房主在哪里？

用 rust 蚀中的future 展望 struct 的future

使用Box优化可选的已知长度数组的内存分配

S，一般性状和联想型性状有什么不同？

在本例中，为什么我不能一次多次borrow 可变变量？

Rust 的多态现象.AsRef与Derf

如何在Rust中缩短数组

由于生存期原因，返回引用的闭包未编译

Rust wasm 中的 Closure：：new 和 Closure：：wrap 有什么区别

使用 select 处理 SIGINT 和子等待！无阻塞

从 rust 函数返回 &HashMap

Rust与_有何区别？

如何使用 Rust Governor 为每 10 秒 10 个请求创建一个 RateLimiter？

使用 lalrpop 在 rust 中解析由 " 引用的字符串

使用 HashMap 条目时如何避免字符串键的短暂克隆？

Rust HRTB 是相同的，但编译器说一种类型比另一种更通用

在空表达式语句中移动的值

加入动态数量的期货