rust - 如何记录二进制 Rust crate 项目？

Question

我有一个用 Rust 编写的程序，我想记录它。我上网查了一下，发现:

https://doc.rust-lang.org/stable/rust-by-example/meta/doc.html

https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text

我在代码中添加了文档注释:

/// This is a documented function
fn example() {
    println!("Hi there");
}

我现在遇到的问题是，在我运行 cargo doc 之后，我得到了为我的程序使用的所有 crates 生成的所有其他文档，但 HTML 文档不会诱导我的程序。我一直在环顾四周，没有看到任何关于仅记录单个程序的内容，通常我会看到有关记录 crate 的 Material 。如果我可以将 Rust 的文档系统用于独立程序，我该怎么做？

Answer 1

问题是您的函数是私有(private)的(这对于二进制 crate 是有意义的)。然而，rustdoc 目前默认只记录公共(public)项目(这对于库 crate 是有意义的)。您可以使用标志 --document-private-items还包括私有(private)功能等:

cargo doc --document-private-items

关于这个特性有一些讨论，我们应该使用默认值here .

此外，我 recently opened a PR更改二进制 crate 的默认行为，以便默认记录二进制 crate 的私有(private)项。预计此更改将于 2020 年 1 月 31 日 (1.41.0) 到达稳定的编译器。