Rust 注释

在计算机编程中，注释是用于描述代码用途的文本行。例如，

// entry point of the program
fn main() {
    // print text on the screen
    println!("Hello, World!");
}

在这里，// entry point of the program 和 // print text on to the screen 是注释。

注释在代码执行期间被完全忽略，不被评估。理想情况下，注释应该让读者能够理解代码的用途。

注释的类型

Rust 中有两种重要的注释类型

• // - 行注释
• /*...*/ - 块注释

Rust 中的行注释

在 Rust 中，我们使用两个前斜杠 // 来创建行注释。例如，

fn main () {
    // declare a variable
    let x = 1;
    println!("x = {}", x);
}

输出

x = 1

在这里，// Declare a variable 是一个行注释。注释一直延伸到行的末尾，也被称为单行注释。

我们也可以在代码的同一行使用行注释。例如，

fn main() {
    let x = 1;    // declare a variable
    println!("x = {}", x);
}

在这里，// Declare a variable 也是一个放在包含代码的行末尾的行注释。

Rust 中的块注释

在 Rust 中，我们使用符号 /*...*/ 来表示块注释。它以 /* 开始，以 */ 结束。例如，

fn main() {
    /*
    declare a variable
    and assign value to it
    */
    let x = 1;
    println!("x = {}", x);
}

输出

x = 1

这里，

/*
declare a variable
and assign value to it
*/

是一个块注释。您可以看到块注释跨越多行。因此，它也被称为多行注释。

我们也可以使用多个行注释来创建多行注释。例如，

fn main() {
    // declare a variable
    // and assign value to it
    let x = 1;
    println!("x = {}", x);
}

输出

x = 1

这里，我们使用了两个单行注释：// declare a variable 和 // and assign value to it，而不是一个多行注释。

注意： 在 Rust 生态系统中，行注释比块注释更受欢迎。

使用 Rust 注释禁用部分代码

注释也用于临时禁用代码块。让我们看一个例子

fn main() {
    let x = 1;
    let y = 2;
    let z = 3;
    println!("z = {}", z);
}

这段代码将引发警告，因为 x 和 y 变量都未被使用。与其完全删除这些声明，不如对它们进行注释。

fn main() {
    /*
    temporarily disable x and y variable declarations.
    let x = 1;
    let y = 2;
    */

    let z = 3;
    println!("z = {}", z);
}

输出

z = 3

现在，只有块注释外的代码才会被评估。我们暂时禁用了导致警告的部分代码。在这些情况下，代码注释会很有帮助。