JSRUN 用代码说话

注释

编辑教程

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 中:

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

JSRUN闪电教程系统是国内最先开创的教程维护系统, 所有工程师都可以参与共同维护的闪电教程,让知识的积累变得统一完整、自成体系。 大家可以一起参与进共编,让零散的知识点帮助更多的人。
X
支付宝
9.99
无法付款,请点击这里
金额: 0
备注:
转账时请填写正确的金额和备注信息,到账由人工处理,可能需要较长时间
如有疑问请联系QQ:565830900
正在生成二维码, 此过程可能需要15秒钟