问题标签 [rustdoc]

在https://doc.rust-lang.org/std/vec/struct.Vec.html#method.iter中，

我只能iter在页面左侧的索引侧边栏中找到。但是，iter_mut找不到。

谁能解释这是故意的还是错误的？

这很不方便，因为从手机浏览时很难搜索文本。我正在滚动浏览索引，但找不到iter_mut.

有没有办法从///评论中生成 doc/ 中的单个降价文件？

多个降价文件（doc/main.md,doc/foo.md等）也会很好。

我是 rust 新手，虽然生成的 HTML 文档很好，但我主要生活在命令行上，真的不想为了阅读文档而在终端和 Web 浏览器之间切换。这打破了流程，让我离开了这个区域。此外，md 很容易转换为手册页，或转换为 TeX 以用于打印或 PDF 文档。

（我习惯于使用 Ctrl-Z 或使用另一个终端选项卡来暂停 vim，并运行manorperldoc或pydoc等。文本模式浏览器像lynxnorlinks对我来说不是很好的选择 - 导航很笨拙，我的 200+ 列上的输出很难看如果我忘记使用该-width选项，终端窗口，并且都不支持 javascript)

我有一个结构，其中所有字段都是私有的，因为它们应该使用公共设置器进行设置。

用它设置的字段的描述来记录 setter 感觉很尴尬。

有没有办法在 rustdoc 上记录和显示私有字段？

我在其他模块中定义了一个结构及其实现main.rs以及在其他模块中定义的补充实现：

当我生成文档时，实现块按此顺序显示（不幸的是，没有显示实现块的来源）：

这似乎不是相对或绝对模块名称的字母顺序（无论箱子名称是aaa还是都无关紧要zzz）。规则是什么？

我希望首先在与结构相同的模块中定义的“主要”函数，然后是针对特定情况的附加函数（在文档中进行了描述）。

可能吗？

如果您查看docs.rs 上的 Tokio 文档，则会有一个蓝色标记表示必须激活某个功能才能访问此 API：

我也想为我的箱子启用这个功能，怎么做？

我正在用 Rust 编写我的第一个二进制 crate，虽然我对所有函数都有文档注释，但运行后没有一个函数出现在文档中cargo doc --no-deps。我在文档中看到的唯一条目是我的箱子的名称，其中一行//!以我的评论开头。

但是，当我将模块标记为公开时，它们确实会出现。所以在我的 main.rs 中，而不是

如果我使用

这些模块与它们的公共功能一起出现。

我发现我还需要为我的main函数执行此操作，之后它会在文档中列出。我不确定我是否应该这样做。

我做对了吗？

正如他们所说，一张照片值 1000 字。我想sequence diagrams在我生成的rust documentation. 有没有办法做到这一点？拥有一个embedded image并没有真正起作用，它更难维护，它是文档之外的资产，等等。

我有一些生成的.rs代码（来自 grpc proto 文件），它们在 src 下使用我的普通 Rust 代码签入，但在一些子模块中。问题是，在进行cargo testdoc 测试时，会运行一些生成.rs的带有缩进（代码块）的注释，而 cargo doc test 将尝试编译它们并失败。

例如cargo test，将尝试编译（并可能运行这些行）show here。

有没有办法排除或忽略.rs为文档测试生成的那些（无需手动更改它们）？

我正在尝试使用mdbook-epub工具以 epub 格式下载Rust 编程语言书，但输出文件不包含任何代码片段。相反，它有这样的占位符：

其中一些占位符使用rustdoc_include.

如何生成带有嵌入片段的文件？

例如，在 Rust 2018 中，我可以使用extern self as crate_name然后使用完全限定的语法

但是我似乎无法让它在 doctest 中工作：

Member错误[E0425]：在模块中找不到值crate_name

我应该提一下，我实际上是在 doctesting 一个 procmacro。也就是说，a) 测试需要包含完全限定的语法，因为 procmacro 会扩展到该语法，b) 我需要调整测试前奏，以便扩展能够编译。基本上，doctest 应该模拟类型/路径，以便 procmacro 可以工作。