rustdoc 文档内设置

rustdoc 的 HTML 输出包含一个设置菜单，本章介绍了此菜单中每个设置的作用。

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

更改显示主题

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

自动隐藏大型项目的项目内容

如果类型定义包含超过 12 个项目，并且此设置已启用，则默认情况下会折叠它们。您可以通过点击 [+] 按钮展开它们来查看它们。

可以在 Iterator 文档页面中看到此设置的实际使用示例。

自动隐藏项目方法的文档

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

自动隐藏特征实现文档

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

示例

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

如果此设置已启用，如果您搜索只返回一个元素，您将直接被带到结果页面。如果您确切地知道要查找的内容，并且想要直接被带到那里，而不是浪费时间选择唯一的搜索结果，这很有用。

在代码示例中显示行号

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

禁用键盘快捷键

如果此设置已启用，则键盘快捷键将被禁用。如果您正在使用的某个网页扩展程序已经使用了这些快捷键，这很有用。

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