2017-02-13 15:43:15 +08:00
|
|
|
|
## 注释
|
|
|
|
|
|
2017-03-19 14:53:41 +08:00
|
|
|
|
> [ch03-04-comments.md](https://github.com/rust-lang/book/blob/master/second-edition/src/ch03-04-comments.md)
|
2017-02-13 15:43:15 +08:00
|
|
|
|
> <br>
|
2018-01-14 13:16:25 +08:00
|
|
|
|
> commit d4c77666f480edfb960cc9b11a31c42f4b90c745
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
2018-01-14 13:16:25 +08:00
|
|
|
|
所有编程语言都力求使其代码易于理解,不过有时需要提供额外的解释。在这种情况下,程序员在源码中留下记录,或者 **注释**(*comments*),编译器会忽略它们不过其他阅读代码的人可能会用得上。
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
2018-01-14 13:16:25 +08:00
|
|
|
|
这是一个简单的注释的例子:
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
|
|
|
|
```rust
|
|
|
|
|
// Hello, world.
|
|
|
|
|
```
|
|
|
|
|
|
2018-01-14 13:16:25 +08:00
|
|
|
|
在 Rust 中,注释必须以两道斜杠开始,并持续到本行的结尾。对于超过一行的注释,需要在每一行都加上 `//`,像这样:
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
|
|
|
|
```rust
|
|
|
|
|
// So we’re doing something complicated here, long enough that we need
|
|
|
|
|
// multiple lines of comments to do it! Whew! Hopefully, this comment will
|
|
|
|
|
// explain what’s going on.
|
|
|
|
|
```
|
|
|
|
|
|
2017-03-19 14:53:41 +08:00
|
|
|
|
注释也可以在放在包含代码的行的末尾:
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
2017-08-15 14:13:09 +08:00
|
|
|
|
<span class="filename">文件名: src/main.rs</span>
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
|
|
|
|
```rust
|
|
|
|
|
fn main() {
|
|
|
|
|
let lucky_number = 7; // I’m feeling lucky today.
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2018-01-14 13:16:25 +08:00
|
|
|
|
不过你会经常看到它们用于这种格式,也就是位于它所解释的代码行的上面一行:
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
2017-08-15 14:13:09 +08:00
|
|
|
|
<span class="filename">文件名: src/main.rs</span>
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
|
|
|
|
```rust
|
|
|
|
|
fn main() {
|
|
|
|
|
// I’m feeling lucky today.
|
|
|
|
|
let lucky_number = 7;
|
|
|
|
|
}
|
2017-02-14 22:42:54 +08:00
|
|
|
|
```
|
2017-02-13 15:43:15 +08:00
|
|
|
|
|
2017-12-04 22:33:03 +08:00
|
|
|
|
Rust 还有另一种注释,称为文档注释,我们将在 14 章讨论它。
|