Rust 程式設計語言

註解

所有程式設計師均致力於讓他們的程式碼易於閱讀，不過有時候額外的解釋還是需要的。這種情況下，開發者會在他們的程式碼留下一些註解（comments），編譯器會忽略這些字，但其他人在閱讀程式碼時可能就會覺得很有幫助。

這是一個簡單地註解：

#![allow(unused)]
fn main() {
// 安安，你好
}

在 Rust 中，慣用的註解風格是用兩行斜線再加上一個空格起頭，然後註解就能一直寫到該行結束為止。如果註解會超過一行的話，你需要在每一行都加上 //，如下所示：

#![allow(unused)]
fn main() {
// 這邊處理的事情很複雜，長到
// 我們需要多行註解來解釋！
// 希望此註解能幫助你理解。
}

註解也可以加在程式碼之後：

檔案名稱：src/main.rs

fn main() {
    let lucky_number = 7; // 幸運 777！
}

不過你會更常看到它們用用以下格式，註解會位於要說明的程式碼上一行：

檔案名稱：src/main.rs

fn main() {
    // 幸運 777！
    let lucky_number = 7;
}

Rust 還有另一種註解：技術文件註解。我們會在第十四章的「發佈 Crate 到 Crates.io」段落提到它。