| 注释类型 | 语法 | 常用场景 |
|---|---|---|
| 行注释 | // ... | 临时说明、逻辑解释、调试用注释。例如在函数内部、代码逻辑前后说明 |
| 块注释 | /* ... */ | 大段注释、临时注释、屏蔽多行代码。多用于内部开发调试或大段说明 |
| 文档注释 | /// ... 或 //! ... | API 文档、公共说明,可被 cargo doc 生成文档时收集。 |
你的场景:对一个结构体简单说明
✅ 推荐使用 文档注释 (///)
原因:
-
文档注释用于描述结构体、函数、模块的用途与设计;
-
被
cargo doc工具提取生成正式文档; -
是正式的、规范的注释方式;
示例:
/// 表示一个二维点。
///
/// 用于图形处理、几何计算等场景。
struct Point {
x: f64,
y: f64,
}
其他场景示例
1. 行注释
fn main() {
let x = 5; // 初始化变量
println!("{}", x); // 打印输出
}
2. 块注释
/* 这是一个块注释
可以跨越多行
一般用于大段说明或屏蔽代码
*/
fn foo() { }
3. 文档注释 (模块级别)
//! 这是当前模块的文档注释。
//! 通常放在文件顶部,描述整个模块的作用。
简单总结口诀
-
写 API 给别人用 → 用文档注释
/// -
写逻辑提示自己看 → 用行注释
// -
写大段调试或屏蔽代码 → 用块注释
/* */