rust - 你如何处理 "could not parse code block as Rust code"rustdoc 警告？

Question

我正在写一些 Rust 文档示例(正在编译):

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

但是 cargo doc 给了我这个 [incorrect] 警告:

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 代码。