如何为内部API编写文档测试？

Question

我正在编写一个包含私有结构和方法的库：

/// Constructs a new `Object`
///
/// Internal API
///
/// # Example
/// ```rust
/// use lib::object::Object;
///
/// let tn = Object::new();
/// ```

当我运行cargo test时，doctest失败，因为Object是私有结构。

是否可以编译并运行？

Answer 1

如果您希望测试编译并运行，我认为不可能，请参阅this related question。

我只想将代码作为示例包含在文档中，而不尝试编译和运行它，您可以通过添加ignore标志将其从测试中排除：

/// ```rust,ignore
/// use lib::object::Object;
///
/// let tn = Object::new();
/// ```