注释

ch03-04-comments.md commit d0acb2595c891de97a133d06635c50ab449dd65c

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

这是一个简单的注释：

1. #![allow(unused)]
2. fn main() {
3. // hello, world
4. }

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

1. #![allow(unused)]
2. fn main() {
3. // So we’re doing something complicated here, long enough that we need
4. // multiple lines of comments to do it! Whew! Hopefully, this comment will
5. // explain what’s going on.
6. }

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

文件名：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 章的 “将 crate 发布到 Crates.io”部分讨论它。