【用Rust写CAD】第二章 第一节 Rust注释

文章目录

• 1、单行注释
• 2、多行注释
• 3、用于说明文档的注释

Rust提供了三种主要的注释方式：单行注释、多行注释和文档注释。‌

1、单行注释

单行注释以两个斜杠 // 开始，仅影响它们后面的内容直到行末。例如：

//这是单行注释的示例
fn main() {
    // 编译器会忽略这里的注释
    let x = 5; // 这是一个变量声明
}

2、多行注释

多行注释以 /* 开始，以 */ 结束，可以在一行，也可以跨越多行。例如：

/*
 * 多行注释
 * 多行注释
 * 多行注释
 */
/* 这是一个多行注释的示例。它可以在一行。 */
fn main(/*也可以在一行中间*/) {
    let y = 10; /* 也
    可
    以
    多
    行
    */
}

3、用于说明文档的注释

在 Rust 中使用 // 可以使其之后到第一个换行符的内容变成注释。
在这种规则下，三个正斜杠 /// 依然是合法的注释开始。所以 Rust 可以用 /// 作为说明文档注释的开头：

/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let x = add(1, 2);
///
/// ```

fn add(a: i32, b: i32) -> i32 {
    return a + b;
}
   
fn main() {
    println!("{}",add(2,3));
}

程序中的函数 add 就会拥有一段优雅的注释，并可以显示在 IDE 中：

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