Rust 注释与文档

注释

• 单行注释定义在//之后
• 多行注释定义在/* */之间

单行注释

// 单行注释
// 单行注释
// 单行注释

多行注释

/*
 * 多行注释
 * 多行注释
 */

文档

包/模块文档

模块文档需要写在//!之后

//! 包/模块文档
//!

// ...
// ...

---

函数文档

函数文档需要写在///之后

/// 函数说明
/// 函数说明
///
/// ### 参数
/// - `参数1` - 说明
/// - `参数2` - 说明
///
/// ### 返回值
/// 说明
///
/// ### 示例
/// ```rs
/// 函数(参数1, 参数2);
/// ```
fn 函数(参数1: 类型, 参数2: 类型) -> 类型 {
    // ...
    // ...
    return 返回值
}