Rust 入门 函数和注释

函数

函数的定义

• 在 Rust 中, 我们已经使用过 函数(function)
• main() 函数是程序的入口点, 它是最重要的函数之一
• rust 代码中的函数名使用下 划线命名(snake case) 规范
• rust 中的函数定义使用 fn 关键字, 关键字后跟随函数名, 函数名之后跟随一对小括号, 小括号之内存放函数的参数, 之后跟随一对大括号, 大括号内编写函数体
• 大括号之前的部分我们称之为 方法签名(method signature)
• 函数的参数必须指定数据类型
• 函数可以附带返回值, 返回值可以是任意类型, 但是不能为返回值命名
• 因为 Rust 是一门基于 表达式(expression-based)的语言, 因此函数体可以由一个表达式作为结束, 此时结尾的表达式就是函数的返回

示例:

fn main() {
    println!("Hello, world!");
    another_function();			// 调用另一个函数
}

fn another_function() {
    println!("Another function.");
}

// 带有返回值的函数
fn return_i32() -> i32 {
    return 1;
}

// 使用表达式作为返回值
fn return_f32() -> f32 {
    2.14 + 1
}

// 方法签名
fn add(a: i32, b: i32)

注释

• 没什么好讲的, 和其他语言差不多
• 注释分为 代码注释 和 文档注释
• 代码注释分为 多行注释 和 单行注释

代码注释

• 单行注释使用双斜线
• 多行注释使用斜线星号开始, 星号斜线结束

示例

// 这是单行注释
/*
 * 这是多行注释
 */

文档注释

• 准确的包文档有助于其他用户理解如何以及何时使用他们，所以花一些时间编写文档是值得的
• 文档注释使用三条斜线
• 文档注释支持 Markdown 标记语法
• 使用命令 cargo doc 来编译文档
• 使用命令cargo doc --open 可以编译后直接打开文档
• 使用命令 cargo doc --help 查看文档帮助

示例

/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let arg = 5;
/// let answer = my_crate::add_one(arg);
///
/// assert_eq!(6, answer);
/// ```
pub fn add_one(x: i32) -> i32 {
    x + 1
}

如果对我分享的内容感兴趣的话  记得关注我得动态
求推荐  求收藏  求转发  求关注