Rust 如何将示例代码添加到私有方法&x27;s文档?

Rust 如何将示例代码添加到私有方法&x27;s文档?,rust,rust-cargo,Rust,Rust Cargo,在记录模块内部函数时,我想在其中添加一些示例代码: //在私有模块foo中 ///这个函数做一些事情等等。 ///例如: /// ``` ///使用mylib::foo::my_func; ///断言!(二,三),; /// ``` fn my_func(x:i32)->i32{ 3. } 运行cargo test不起作用,因为foo是私有的(而且应该是私有的),所以我得到了很多失败的测试 我读过关于在代码段上放置ignore标记的文章,但是这似乎不是一个好的解决方案,因为我更喜欢检查代码 也

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

//在私有模块foo中
///这个函数做一些事情等等。
///例如:
/// ```
///使用mylib::foo::my_func;
///断言!(二,三),;
/// ```
fn my_func(x:i32)->i32{
3.
}
运行
cargo test
不起作用,因为
foo
是私有的(而且应该是私有的),所以我得到了很多失败的测试

我读过关于在代码段上放置
ignore
标记的文章,但是这似乎不是一个好的解决方案,因为我更喜欢检查代码


也许是单元测试:我知道如何测试它们,但我想有示例代码,抱歉,不可能:(至少我知道)你可以考虑在GITHUB上提交一个问题,因为这似乎是一个常见的问题,但是我想不出一个合理的方法来解决这个问题。使用单元测试作为内部函数的示例代码对我来说似乎是最合理的选择。感谢您的想法,我想我现在必须依赖未经检查的示例代码。我会查看github问题跟踪程序,谢谢您的帮助。