Rust 注释

在 Rust 中，注释是一种用于编写代码文档、调试代码和提高代码可读性的重要工具。Rust 支持两种不同类型的注释：行注释和块注释。

行注释

行注释以 // 开始，并在行末结束。行注释通常用于解释单个语句或行的作用。例如：

fn main() {
    // 打印 "Hello, world!" 到控制台
    println!("Hello, world!");
}

块注释

块注释以 /* 开始，以 */ 结束。块注释可以跨越多行，并通常用于禁用代码（例如，暂时删除某些语句）或包含大量文本的注释。例如：

/*
这是一个 
多行
注释。
*/

fn main() {
    /*
    println!("Hello, world!");
    */
    println!("Hi there!");
}

文档注释

Rust 还支持一种特殊的注释类型 - 文档注释 (/// 和 //!)。文档注释可以用于编写 Rust crate、模块、函数和类型的 API 文档。例如：

/// 这是一个简单的函数，将两个数字相加并返回结果。
///
/// # Examples
///
/// ```
/// let result = add(2, 3);
/// assert_eq!(result, 5);
/// ```
fn add(x: i32, y: i32) -> i32 {
    x + y
}

以上文档注释展示了 add 函数接口的用法和使用示例，可以被 Rust 提供的工具用来生成 API 文档。

在 Rust 中，注释被认为是代码的一部分，因此应该小心地编写注释以确保其正确性和清晰度。