rustdoc 允许您通过在每行上方包含文档注释来记录结构字段和枚举变体：

这些将在 rustdoc 生成的 HTML 中以很好的格式显示出来。但是，我还没有看到任何方法可以为函数参数制作类似的格式良好的文档。是否有一种“官方”的方式来记录它们，或者您只需要在函数的主要文档部分中自由地描述它们吗？

当您使用 Cargo 和 rustdoc 为 Rust 板条箱生成文档时，我在生成的页面中看不到任何指示它适用于哪个版本的板条箱。例如，查看log crate 的文档。有没有办法知道一组文档适用于哪个版本的板条箱？

有一个很棒的工具 rustdoc（目前由cargo使用）来测试 Rust 中的文档注释示例。rdoc 或 yard 是否在 Ruby 中为我们提供了类似的东西？

我想查看我的程序所依赖的库的 rust 文档。我怎样才能把这些拉下来？我在标准库的答案中找到了一个问题，但我正在专门寻找 crates.io 依赖项。

我正在构建一个 Rust 库并想对其进行一些润色。在 rustdoc 中，我有时想链接到文档中库的其他部分，例如fns、traits 或structs。这个的官方语法是什么？

我很难在我的库的文档示例中修复错误。我有像我的箱子一样的文件结构bignum

在我的示例中，我的标题看起来像

这可以编译并且效果很好，但是现在当我在我的文档中编写示例时lib.rs，我似乎无法导入bignum::inits::Zero

当我运行时cargo test，我收到此错误

我已经看到了这个问题，但这涉及从仍然需要顶级范围的同一文件中导入模块。但是在这里我仍然用bignum::.

因此，虽然导入bignum::inits::Zero适用于我的所有测试和示例，但它不适用于我的文档。这是为什么？我尝试self::在前面追加并收到相同的错误。如果我将文档示例更改为

但是它编译得很好。如何正确导入我的模块？

我刚刚开始使用 Rust，并试图为我编写的代码生成文档。当我发布时cargo doc，我看到了一些奇怪的东西。

当我打开时my_project/target/doc/my_project/index.html，我注意到所有依赖项都包含在我的文档中：

我希望对用户隐藏这些依赖项的文档，因此我的文档仅显示如何使用我的代码。

我怎样才能做到这一点？

货锁

我正在尝试为我正在用 Rust 编写的项目编写文档。其中一个文档需要使用regex::Regex. 这是我正在尝试编写的文档：

它给了我这个错误：

但是当我添加时extern crate regex;，我得到了这个错误：

相关文件的一些相关部分是：

src/lib.rs：

src/tokenize/mod.rs：

（顶部）src/tokenize/util.rs：

我的项目布局做错了什么？

我注意到编译器插件经常提供文档甚至不会提及的宏。它们是通过编程方式注册和创建的，而不是在 rustdoc 识别的语法中定义的。自然，无法显示任何文档。

我正在寻找一种方法来解决这个问题，一种为编译时 crate 中不存在的宏生成文档的方法。

我注意到语法箱也可以从这样的事情中受益。quote_item，例如，完全没有记录。我什至找不到注册它的代码。

从 Rust 1.6.0 开始，生成的文档隐藏了每个宏模式的实现：

有没有办法从 Cargo 生成的文档中隐藏一些模式？