方唐镜

大人,我刚才那句话不算数!我是跟师爷开玩笑的,没记录在案吧?

包龙星

算你走运!师爷(编译器)耳朵背,没听见。这些话就是注释,虽然写了,但不会执行。

第八回:公堂悄悄话,Rust 注释

注释是写给人看的,不是写给机器看的。在编译的时候,Rust 编译器会像选择性耳聋一样忽略掉它们。

1. 单行注释 (悄悄话)

// 开头,直到行尾。就像在公堂上侧过头跟师爷小声嘀咕。

fn main() {
    // 这是一个注释,编译器看不见我
    let x = 5; // 这一行后面也是注释
    println!("x = {}", x);
}

2. 多行注释 (长篇大论)

/* 开头,用 */ 结尾。如果你废话很多,就用这个。

/*
    我是方唐镜,
    我是全广东最棒的状师,
    不服你来打我啊!
*/
fn main() {
    println!("打你又怎么样!");
}

3. 文档注释 (立碑著书)

/// 开头。这种注释不仅给人看,还能生成漂亮的 HTML 文档书。这才是大师风范!

/// 这是一个用来打人的函数
/// 
/// # 参数
/// * `name` - 被打的人的名字
fn hit(name: &str) {
    println!("打 {}!", name);
}

动手时刻:隐藏罪证

方唐镜想消灭罪证,请把下面这行代码变成注释,让它不执行:

fn main() {
    println!("我是清官");
    println!("我收了黑钱"); // 请把这行注释掉
}
下一回:圣旨到(函数) →