Rust学习笔记（三）——注释

和大多数高级语言一样，Rust同样支持单行注释和多行注释。

单行注释

单行注释是**//或///开头的注释内容，Rust会将//或///到其后的第一个换行符之间的内容作为注释内容。
所不同的是，以三个反斜杠///开头注释，只能放在代码的最前面，作为整个文件的注释内容。而以两个反斜杠//**开头注释，可以放在任意位置。

/// 这是单行注释
/// 三个反斜杠只能放在这里
// 这也是单行注释
fn main() {// 两个反斜杠也可以放这里
    // 两个反斜杠还可以放这里
    println!("{}",6); // 两个反斜杠还可以放这里
    // 两个反斜杠还可以放这里
}// 两个反斜杠还可以放这里
// 两个反斜杠还可以放这里

多行注释

多行注释以** /* 开始，以 */ **结束。中间可以写入多行注释内容。多行注释在代码中的位置，也是可以随意放置的。

/*
这是多行注释，所以
再来一行也是可以的
*/
fn main() {
    /*多行注释放这里
    也一样是可以的*/
    println!("{}",6);
    /*多行注释放这里
    也一样是可以的*/
}/*多行注释放这里
也一样是可以的*/

Rust的编译工具Cargo 具有 cargo doc 功能，开发者可以通过这个命令将工程中的说明注释转换成 HTML 格式的说明文档。