注释

ch03-04-comments.md


commit d4c77666f480edfb960cc9b11a31c42f4b90c745

所有编程语言都力求使其代码易于理解，不过有时需要提供额外的解释。在这种情况下，程序员在源码中留下记录，或者 注释（comments），编译器会忽略它们不过其他阅读代码的人可能会用得上。

这是一个简单的注释的例子：

  1. // Hello, world.

在 Rust 中，注释必须以两道斜杠开始，并持续到本行的结尾。对于超过一行的注释，需要在每一行都加上 //，像这样：

  1. // So we’re doing something complicated here, long enough that we need
  2. // multiple lines of comments to do it! Whew! Hopefully, this comment will
  3. // explain what’s going on.

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

文件名: src/main.rs

  1. fn main() {
  2.     let lucky_number = 7; // I’m feeling lucky today.
  3. }

不过你会经常看到它们用于这种格式，也就是位于它所解释的代码行的上面一行：

文件名: src/main.rs

  1. fn main() {
  2.     // I’m feeling lucky today.
  3.     let lucky_number = 7;
  4. }

Rust 还有另一种注释，称为文档注释，我们将在 14 章讨论它。