註解

本集目標

學會在程式碼裡寫筆記（註解），讓自己和別人看得懂你在幹嘛。

正文

寫程式的時候，有時候你會想在旁邊做個筆記，提醒自己「這段在幹嘛」。這就是註解的用途。

註解不會被電腦執行，它純粹是寫給人看的。

單行註解

用 // 開頭，後面的內容整行都是註解：

fn main() {
    // 這是一個註解，電腦會忽略這行
    let x = 5; // 也可以寫在程式碼後面
    println!("{}", x);
}

跑起來還是只會印出 5，那兩行註解完全不會影響程式。

多行註解

如果你要寫很長的筆記，可以用 /* */ 把它包起來：

fn main() {
    /* 
        這是多行註解
        可以寫好幾行
        電腦通通會忽略
    */
    let x = 10;
    println!("{}", x);
}

什麼時候要寫註解？

• 當這段程式碼的邏輯不太明顯的時候
• 當你怕自己過幾天回來看會忘記的時候
• 當你想暫時讓某行程式碼不要執行（把它「註解掉」）

fn main() {
    let x = 5;
    // println!("{}", x); // 暫時不印，但不想刪掉
    println!("程式結束");
}

這樣 println!("{}", x); 就不會被執行了，但你隨時可以把 // 拿掉讓它復活。

小提醒

不用每一行都寫註解喔！好的程式碼本身就應該夠清楚。註解是用在「不明顯」的地方，不是每行都要解釋。

重點整理

• // 是單行註解，/* */ 是多行註解
• 註解是寫給人看的，電腦完全忽略
• 可以用註解暫時「關掉」某行程式碼，不用刪掉它
• 好的程式碼本身就該夠清楚，註解用在不明顯的地方就好