文档测试

基本用法

/// 两个数相加
///
/// # Examples
///
/// ```
/// let result = my_crate::add(2, 3);
/// assert_eq!(result, 5);
/// ```
pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

▶ Run

测试错误示例

/// 除法函数
///
/// # Panics
///
/// 如果除数为 0，函数会 panic
///
/// ```should_panic
/// my_crate::divide(1, 0);
/// ```
pub fn divide(a: i32, b: i32) -> i32 {
    a / b
}

▶ Run

隐藏代码行

/// 示例函数
///
/// ```
/// # // 这行不会出现在文档中
/// # fn setup() {}
/// # setup();
/// let result = my_crate::func();
/// assert_eq!(result, 42);
/// ```
pub fn func() -> i32 {
    42
}

▶ Run

运行文档测试

# 只运行文档测试
cargo test --doc

# 生成并测试文档
cargo test --doc

# 生成文档
cargo doc

# 生成并打开文档
cargo doc --open