Rust 注释与文档注释

注释帮助人理解代码。Rust 还支持文档注释，可以直接生成 API 文档。

普通注释

单行注释：

// 读取传感器值
let value = 23.5;

多行注释：

/*
这里可以写多行说明。
*/

普通注释不会出现在生成的文档中。

文档注释使用 ///，通常写在函数、结构体、枚举、模块前面：

/// 计算两个整数之和。
fn add(a: i32, b: i32) -> i32 {
    a + b
}

为 crate 或模块写文档，可以使用 //!：

//! 这是当前 crate 的说明。

cargo doc --open

Cargo 会生成 HTML 文档并在浏览器中打开。

文档注释中的代码也可以被测试：

/// 返回两数之和。
///
/// # Examples
///
/// ```
/// let result = add(2, 3);
/// assert_eq!(result, 5);
/// ```
fn add(a: i32, b: i32) -> i32 {
    a + b
}

运行：

cargo test

Rust 会检查文档示例是否仍然可用。

你需要掌握：