首页
会员中心
到顶部
到尾部
Rust教程

Rust 注释

时间:2020/11/3 9:37:50  作者:  来源:  查看:0  评论:0
内容摘要:Rust 注释 Rust 中的注释方式与其它语言(C、Java)一样,支持两种注释方式: 实例 // 这是第一种注释方式/* 这是第二种注释方式 */ /*  * 多行注释 * 多行注释 * 多行注释 */ 用于说明文档的注释 在 Ru...

Rust 注释

Rust 中的注释方式与其它语言(C、Java)一样,支持两种注释方式:

实例

// 这是第一种注释方式

/* 这是第二种注释方式 */

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

用于说明文档的注释

在 Rust 中使用 // 可以使其之后到第一个换行符的内容变成注释。

在这种规则下,三个反斜杠 /// 依然是合法的注释开始。所以 Rust 可以用 /// 作为说明文档注释的开头:

实例

///?Adds?one?to?the?number?given.
///
///?#?Examples
///
///?```
///?let x = add(1, 2);
///
///?```

fn add(a: i32, b: i32) -> i32 {
    return a + b;
}
   
fn main() {
    println!("{}",add(2,3));
}

程序中的函数 add 就会拥有一段优雅的注释,并可以显示在 IDE 中:

Rust 注释

Tip:Cargo 具有 cargo doc 功能,开发者可以通过这个命令将工程中的说明注释转换成 HTML 格式的说明文档。



上一篇:Rust 数据类型
下一篇:Rust 函数
相关评论
广告联系QQ:45157718 点击这里给我发消息 电话:13516821613 杭州余杭东港路118号雷恩国际科技创新园  网站技术支持:黄菊华互联网工作室 浙ICP备06056032号