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

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

1 个答案: