文档测试

文档注释中的代码将由 cargo test 自动执行。这些被称为文档测试,有助于确保你的示例有效并且不会误导你的箱子用户。

你可以从包根导入相对(就好像示例顶部有隐藏的 extern crate mycrate;

/// ```
/// use mycrate::foo::Bar;
/// ```

如果你的代码可能无法在文档测试中正确执行,则可以使用 no_run 属性,如下所示:

/// ```no_run
/// use mycrate::NetworkClient;
/// NetworkClient::login("foo", "bar");
/// ```

你还可以指出你的代码应该是恐慌,如下所示:

/// ```should_panic
/// unreachable!();
/// ```