Rust的注释

Rust的注释

Rust的注释有两种:

  1. 普通注释
    • // 对整行进行注释
    • /* .. */ 对区块注释
  2. 文档注释
    • /// 生成库文档,一般用于函数或者结构体的说明,置于说明对象的上方
    • //! 也生成库文档,一般用于说明整个模块的功能,置于模块文件的头部

示例:

/// # 文档注释: Sum函数
/// 该函数为求和函数
/// # usage:
///    assert_eq!(3, sum(1, 2));
fn sum(a: i32, b: i32) -> i32 {
    a + b
}
pub fn annotation() {
    // 这是单行注释的示例
    /*
         * 这是区块注释, 被包含的区域都会被注释
         * 你可以把/* 区块 */ 置于代码中的任何位置
    */
    /*
        注意上面区块注释中的*符号,纯粹是一种注释风格,
        实际并不需要
        */
    let x = 5 + /* 90 + */ 5;
    println!("Is `x` 10 or 100? x = {}", x);
    println!("2 + 3 = {}", sum(2, 3));
}

文档注释

文档注释支持 markdown !!

还支持对文档中的示例代码进行测试,可以用 rustdoc 工具生成 HTML 文档