Rust 注釋

ch03-04-comments.md

commit d281b7b062e6dbfbcf47f8381073f7fce9e5cd4e

所有程序員都力求使其代碼易于理解，不過有時還需要提供額外的解釋。在這種情況下，程序員在源碼中留下 注釋（comments），編譯器會忽略它們，不過閱讀代碼的人可能覺得有用。

這是一個簡單的注釋：

// hello, world

在 Rust 中，慣用的注釋樣式是以兩個斜杠開始注釋，并持續(xù)到本行的結尾。對于超過一行的注釋，需要在每一行前都加上 ?//?，像這樣：

// 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.

注釋也可以放在包含代碼的行的末尾：

文件名: 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 發(fā)布到 Crates.io” 部分討論它。