注释

所有程序员都努力使他们的代码易于理解,但有时需要额外的解释。在这些情况下,程序员会在源代码中留下 注释,编译器会忽略这些注释,但阅读源代码的人可能会发现它们很有用。

这是一个简单的注释:

#![allow(unused)]
fn main() {
// hello, world
}

在 Rust 中,惯用的注释风格是以两个斜杠开始注释,注释会一直持续到行尾。对于跨越多行的注释,你需要在每一行都包含 //,像这样:

#![allow(unused)]
fn main() {
// 我们在这里做一些复杂的事情,复杂到需要
// 多行注释来解释!哇!希望这个注释能
// 解释清楚发生了什么。
}

注释也可以放在包含代码的行尾:

文件名: src/main.rs

fn main() {
    let lucky_number = 7; // I'm feeling lucky today
}

但你更常见的是看到它们以这种格式使用,注释位于它所注解的代码上方的一行:

文件名: src/main.rs

fn main() {
    // I'm feeling lucky today
    let lucky_number = 7;
}

Rust 还有另一种注释,称为文档注释,我们将在第 14 章的 “发布 Crate 到 Crates.io” 部分讨论。