rust - 您如何处理“无法将代码块解析为 Rust 代码”的 rustdoc 警告？

Question

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

/// ```rust
/// # #[macro_use]
/// # extern crate ...
/// ...
/// ```

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

warning: could not parse code block as Rust code
   --> srml/support/src/dispatch.rs:105:5
    |
105 |   ///    ```rust
    |  ________^
106 | | /// # #[macro_use]
    | |_
    |
    = note: error from rustc: unknown start of token: `
help: mark blocks that do not contain Rust code as text
    |
105 | ///    ```textrust
    |        ^^^^^^^

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

Answer 1

您可以通过在代码块中使用有效的 Rust 代码来修复错误。

---

这重现了问题：

///    ```rust
///
///    ```
pub fn foo() {}

不要在代码块之前添加虚假的空格。在 Markdown 中，四个空格算作代码的开头，因此您实际上已经完成了与 HTML 等价的操作：

<code>```rust  ```</code>

正如它告诉你的那样，```不是有效的 Rust 代码。