Rust 程序设计语言 中文版

注释

所有的开发者都在努力使他们的代码容易理解，但有时需要额外的解释。在这种情况下，开发者在他们的源码中留下注释，编译器将会忽略掉这些内容，但阅读源码的人可能会发现有用。

这是一条简单的注释：

#![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” 章节中进行讨论。