问题标签 [rustdoc]

Rust 书的这一部分似乎暗示可以将 Rust 文档保存在单独的 .md 文件中，但它没有说明如何将这些 .md 文件包含回来。这是如何运作的？

我正在尝试编写一个名为insert. 测试函数在测试的最后一行被调​​用，当我把它注释掉时，测试就通过了。

错误信息：

代码：

是否有特殊规则可以通过 rustdoc 测试（例如使用assert!宏来证明它返回正确的值）？

我问是因为我的方法通过了非常相似的代码的集成测试，所以我很有信心它是正确的

我正在开发一个密集使用 build.rs 文件的小项目。似乎为 Cargo.tomlcargo doc --all生成文档，[dependencies]但不为[build-dependencies]in Cargo.toml 生成文档。

如何为构建依赖包生成离线文档？

我有一个项目：

当我运行时cargo doc，我只有文档main.rs，而不是模块。

在我的main.rs我有：

我尝试使用 ///or记录模块//!。

我在 's 帮助中找不到rustdoc如何做到这一点。

有人可以解释一下吗？

我想记录我的箱子并在文档中包含一个表格：

渲染cargo doc结果如下：

这就是我要的。但是，您可能已经注意到一个源代码行很长。事实上，超过 100 个字符。像许多 Rust 项目一样，我希望将所有行保持在 100 个字符以下。所以我试图以某种方式打破界限。

所有这些版本：

结果是：

在不违反行长限制的情况下，我必须在我的文档中包含长表行的哪些选项？

我有一个模块，我想在我的文档中的代码块中使用它。

该模块仅用于测试，因此它具有#![cfg(test)]应保留的属性。

但是，因此，在对文档运行测试时，似乎没有包含此文件。

看看 MVCE：

库文件

模拟.rs

这失败了：

有没有办法让我的文档测试代码使用这些为测试配置的文件？

我正在写一些 rust doc 示例（正在编译）：

但是cargo doc给了我这个[不正确的]警告：

我应该压制这个警告..还是这里有什么东西？

在decl_storage!中，用于工具提示警告的语法似乎是/!\（即/!\ Be careful ...）。如果它是一个工具提示警告，最好使用 HTML 语法（即使用 HTML，例如<b></b>）以粗体或斜体文本显示它。在 rustdocs 中显示工具提示警告的标准是什么？

如果readme Cargo.toml设置了键，则 doc.rs 在 crate 的索引页面上呈现 README。cargo doc在本地运行时有没有办法模拟这个？

如果我添加：

从字面上看，我得到了我正在寻找的行为，但是内联我的整个 README.md 的副本对于进行更新非常不方便。

我试过了：

但这给出了一个错误：

我试图避免在每个 GDB 会话中输入相同的命令。为此，我已按照rust discovery book中的说明进行操作，但是当我通过 cargo run 运行程序时，程序无法按照书中所述运行，它给出以下错误：

我的 openocd.gdb 文件包含以下内容：

我的配置文件包含以下内容：