在 Rust 编程中,注释是代码文档化和维护的关键工具。Rust 提供了两种主要类型的注释:普通注释和文档注释,它们各有不同的用途和语法。
普通注释
普通注释用于在代码中添加临时说明或禁用部分代码,不会影响编译输出。Rust 支持两种形式的普通注释:行注释和块注释。
行注释以 // 开头,适用于单行说明。例如:
// 这是一个行注释,用于解释下一行代码
let x = 5; // 初始化变量 x
块注释以 /* 开始,以 */ 结束,可以跨越多行。例如:
/*
这是一个块注释,
用于详细说明复杂逻辑。
*/
注意:普通注释在编译时会被忽略,主要用于开发者内部沟通。
文档注释
文档注释用于生成正式的 API 文档,可以通过 cargo doc 命令生成 HTML 文档。Rust 支持两种文档注释:行文档注释和块文档注释。
行文档注释以 /// 开头,通常用于函数、结构体或模块的文档。例如:
/// 计算两个数字的和。
///
/// # 参数
/// - `a`: 第一个数字
/// - `b`: 第二个数字
///
/// # 返回值
/// 返回 `a + b` 的结果。
///
/// # 示例
/// ```
/// println!("{}",add(1,2)); // 3
/// ```
fn add(a: i32, b: i32) -> i32 {
a + b
}
提示:文档注释支持 Markdown 语法,可以添加代码块、列表等格式,提升文档可读性。
块文档注释以 /** ... */ 格式编写,适用于更长的文档。例如:
/**
这个模块提供数学运算功能。
包括加法、减法等基本操作。
*/
mod math {
// 模块内容
}
生成文档
使用 cargo doc 命令可以生成文档,可在src/target/doc目录下查看;
可添加--open参数使用浏览器自动打开:
cargo doc --open
文档效果图