13. 注释

在 Move 编程语言中，注释用于向代码添加解释或文档，编译器会忽略注释内容，它们不会影响代码的执行。注释可以用于解释代码的功能、添加开发者笔记、临时禁用代码段或生成文档。

注释类型

Move 中有三种类型的注释：

行注释：使用双斜杠 // 注释掉一行代码。// 后的所有内容都会被编译器忽略。
块注释：使用 /* 和 */ 注释掉一段代码。/* 和 */ 之间的所有内容都会被编译器忽略。可以使用块注释注释掉单行或多行代码，甚至可以注释掉一行代码的一部分。
文档注释：一种特殊的块注释，用于生成代码文档。文档注释以三个斜杠 /// 开头，通常放在要文档化的项的定义之前。

行注释以 // 开头，用于注释掉该行代码的剩余部分。

move

// 这是一行注释
let x = 10; // 也可以在代码后面添加注释

块注释以 /* 开头，以 */ 结尾，可以注释掉多行代码。

move

/*
    这是一个块注释
    可以跨越多行
*/

let x = 10;
let y = 20;

文档注释以 /// 开头，用于生成代码文档。它们通常放在模块、结构体、函数和常量的定义之前。文档注释不仅能提高代码的可读性，还能通过工具自动生成文档。

move

/// 这是一个文档注释
/// 用于描述模块的功能
module my_module {
    // 模块的具体实现
}

/// 这是一个文档注释
/// 用于描述函数的功能
fun my_function() {
    // 函数的实现
}