如何将示例代码添加到私有方法的文档中?

时间:2019-07-01 07:20:52

标签: rust rust-cargo

在记录模块内部功能时,我想在其中添加一些示例代码:

// in private module foo

/// This functions does something etc.
/// Example:
/// ```
/// use mylib::foo::my_func;
/// assert_eq!(my_func(2), 3);
/// ```
fn my_func(x: i32) -> i32 {
    3
}

运行cargo test不起作用,因为foo是私有的(应该是私有的),所以我遇到了很多失败的测试。

我读到有关将ignore标签放在代码段中的信息,但这似乎不是一个好的解决方案,因为我希望对代码进行检查。

处理这种情况的正确方法是什么?

0 个答案:

没有答案