如何让cargo doc仅生成公共API文档，不包含pub(crate)项？

针对二进制crate下rustdoc默认会包含pub(crate)项的问题，无需逐个添加#[doc(hidden)]的实现方法如下：

方法一：将对外API抽离为内部库 #

这是最简洁且符合Rust项目结构规范的方案——库crate的rustdoc默认只会生成对外公开（pub）的API文档，自动排除pub(crate)项。

1. 在项目中创建src/lib.rs文件，把所有需要对外展示的pub项迁移到该文件中；
2. 原二进制入口src/main.rs通过导入内部库的方式使用这些API；
3. 运行cargo doc即可自动生成仅包含对外pub项的文档。

示例代码结构：

• src/lib.rs:

pub struct DocumentMe;

// 此pub(crate)项不会出现在生成的文档中
pub(crate) struct DoNotDocumentMe;

• src/main.rs:

use your_crate_name::DocumentMe;

fn main() {
    let _instance = DocumentMe;
}

方法二：使用rustdoc的过滤参数（临时方案） #

如果不想拆分库，可通过rustdoc参数手动控制文档范围，但这种方式需要每次构建时指定参数：
运行以下命令生成仅包含对外pub项的文档：

cargo doc --no-defaults --document-public-items

不过这种方式在复杂项目中可能存在边缘情况，推荐优先使用方法一。

注：此问题仅存在于二进制crate，库crate的rustdoc默认行为就是只展示对外pub项。

内容的提问来源于stack exchange，提问作者Steven Spungin