Rustdoc 文档内设置

Rustdoc 的 HTML 输出包含一个设置菜单，本章将介绍此菜单中每个设置的功能。

可以通过单击右上角的齿轮按钮 () 来访问它。

更改显示主题

可以更改主题。 如果选择“系统偏好”，您将看到两个新的子菜单：“首选浅色主题”和“首选深色主题”。 这意味着如果您的系统偏好设置为“浅色”，则 rustdoc 将使用您在“首选浅色主题”中选择的主题。

自动隐藏大型条目的内容

如果类型定义包含 12 个以上的条目，并且启用了此设置，则默认情况下将折叠这些条目。 您可以通过单击 [+] 按钮来展开它们以查看它们。

可以在 Iterator 文档页面中看到此设置的良好示例

自动隐藏条目方法文档

如果启用此设置，将折叠所有 trait 实现块。 如果您只想查看所有可用方法的概述，则很方便。 您仍然可以通过展开它来查看方法的文档。

自动隐藏 trait 实现文档

如果启用此设置，将折叠所有 trait 实现块（您可以在“Trait 实现”部分中看到它们）。 如果您只想查看类型上实现的所有 trait 的概述，则很方便。 您仍然可以通过展开它来查看 trait 实现的关联项。

示例

如果只有一个结果，则直接转到搜索中的项目

如果启用此设置，如果您的搜索只返回一个元素，您将直接被带到结果页面。 如果您确切知道自己在寻找什么，并且希望直接被带到那里而不是浪费时间选择唯一的搜索结果，这将非常有用。

在代码示例中显示行号

如果启用此设置，将在文档中的代码示例中添加行号。 它为代码阅读提供了视觉辅助。

禁用键盘快捷键

如果启用此设置，将禁用键盘快捷键。 如果您正在使用的某些 Web 扩展已经使用了这些快捷键，这将非常有用。

要查看 rustdoc 键盘快捷键的完整列表，您可以打开帮助菜单（设置菜单按钮左侧带有问号的按钮）。