mirror of
https://github.com/gnu4cn/rust-lang-zh_CN.git
synced 2025-01-13 13:50:37 +08:00
Refining Ch03.
This commit is contained in:
parent
12bf2a6d30
commit
a46c942060
@ -1,20 +1,29 @@
|
||||
# 注释
|
||||
|
||||
所有程序员都会致力于让他们的代码易于理解,而有时是需要额外解释的。在这种情况下,程序员们就会在他们的源代码中,留下会被编译器忽略的 *注释(comments)*,而那些阅读到源代码的人会发现有用。
|
||||
**Comments**
|
||||
|
||||
|
||||
所有程序员都努力使自己的代码易于理解,但有时也需要一些额外的解释。在这种情况下,程序员会在源代码中留下 *注释,comments*,编译器会忽略这些注释,但阅读源代码的人可能会发现有用。
|
||||
|
||||
下面就是个简单的注释:
|
||||
|
||||
```rust
|
||||
// hello, world
|
||||
```
|
||||
在 Rust 中,惯用的注释风格,是以双斜杠来开始一条注释,同时该注释会持续到那行的结束。对于那些超过一行的注释,在每行注释就都要包含 `//`,就像这样:
|
||||
|
||||
|
||||
在 Rust 中,惯用的注释风格,以两个斜线开始一条注释,而该注释会一直持续到行尾。对于超出单个行的注释,咱们需要在每一行,都包含 `//`,像下面这样:
|
||||
|
||||
|
||||
```rust
|
||||
// 那么这里要编写一些复杂的注释,这注释长到要用多个行
|
||||
// 才能写完!噢!还好,这条注释会解释接下来要做些什么。
|
||||
// 所以我们要做的事情很复杂,长到我们需要
|
||||
// 多行注释来完成!呼!希望这条注释能
|
||||
// 解释发生了什么。
|
||||
```
|
||||
|
||||
注释也可以放在那些包含代码行的末尾:
|
||||
|
||||
注释也可以放在包含了代码行的末尾:
|
||||
|
||||
|
||||
文件名:`src/main.rs`
|
||||
|
||||
@ -24,7 +33,8 @@ fn main() {
|
||||
}
|
||||
```
|
||||
|
||||
不过更常见的则是以下面这种形式运用的注释,其中注释位处单独的、在其要注解代码之上的行:
|
||||
但咱们更经常看到的是,将注释放在其所注释代码上方单独一行,这种形式:
|
||||
|
||||
|
||||
文件名:`src/main.rs`
|
||||
|
||||
@ -35,4 +45,4 @@ fn main() {
|
||||
}
|
||||
```
|
||||
|
||||
Rust 还有另外一种注释,叫做文档注释,在第 14 章的 [将代码箱发布到 Crates.io](Ch14_More_about_Cargo_and_Crates.io.md#将代码箱发布到-cratesio) 中会对文档注释进行讨论。
|
||||
Rust 还有另一种注释,即文档注释,documentation comments,我们将在第 14 章 [“将 Crate 发布到 Crates.io”](../crates-io/publishing.md) 一节中讨论。
|
||||
|
Loading…
Reference in New Issue
Block a user