【用Rust写CAD】第三章 第一个Rust程序 第二节 Rust注释

注释用于解释代码的作用和目的，帮助开发者理解代码的行为，编译器在编译时会忽略它们。
通过编写清晰和详细的文档注释，可以使代码更易于理解，并帮助其他开发者更好地利用你的代码或库。Rust提供了三种主要的注释方式：单行注释、多行注释和文档注释。‌

文章目录

• 1、单行注释
• 2、多行注释
• 3、文档注释
• • 3.1、单行文档注释
  • 3.2、多行文档注释
  • 3.3、模块注释
  • 3.4、Markdown 支持
• 4、结束语

1、单行注释

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

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

2、多行注释

多行注释以 /* 开始，以 */ 结束，可以跨越多行、可以在一行，也可以在语句内，甚至可以嵌套。例如：

/*
 * 可
 * 以
 * 多
 * 行
 */
/* 这是一个多行注释的示例。它可以在一行。 */
fn main(/*也可以语句内*/) {
    /*第一层注释
    	/*
    	第二层注释
    		/*还可以继续套娃下去*/
    	*/
    */
}

3、文档注释

在 Rust 中，文档注释不仅对代码的阅读者提供了有价值的指导和解释，它们还被用来生成库的文档。Cargo 具有 cargo doc 功能，开发者可以通过这个命令将工程中的文档注释转换成 HTML 格式的说明文档。

3.1、单行文档注释

单行文档通常以 /// 开始，仅影响它后面的内容直到行末。可以解释函数、结构体、枚举、模块等。例如

/// 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 中：

3.2、多行文档注释

多行注释以 /** 开始，以 */ 结束，如果注释说明比较长或者需要分段，那么这种方式就很有用。

3.3、模块注释

在模块或文件级别，可以使用 //! 来为整个模块或文件添加文档注释：

//! math crate
//!
//! `math` 是一个演示如何使用文件级文档注释的例子
//!
//! 它包含以下两个函数。
//! - add
//! - subtract

这通常位于文件的开始或模块的顶部。cargo doc 会将这一部分作为整个模块或 crate 的文档。

3.4、Markdown 支持

Rust 的文档注释支持使用 Markdown 语法来格式化文本。可以使用 Markdown 来添加标题、列表、代码块等格式化元素。

4、结束语

通过编写清晰和详细的文档注释，可以使代码更易于理解，并帮助其他开发者更好地利用你的代码或库。