Rust 函数简介

Rust 是一种系统级编程语言，以安全、并发和性能见长。在 Rust 中，函数是组织代码和实现功能的基本单位。本文将为程序员介绍 Rust 函数的基本概念、语法和使用方法。

函数的定义和语法

Rust 函数的定义如下：

fn function_name(parameter1: Type1, parameter2: Type2) -> ReturnType {
    // 函数体
    // 可以包含多条语句和表达式
    // 最后一条语句的结果将作为返回值返回
}

• fn 关键字用于声明一个函数。
• function_name 是函数的名称，命名遵循 Rust 的命名规范。
• parameter1: Type1 和 parameter2: Type2 是函数的参数列表，每个参数包含名称和类型声明。
• ReturnType 是函数的返回类型。
• 函数体内可以包含多条语句和表达式，函数体的最后一条语句的结果将作为返回值返回。

以下是一个计算两个数之和的函数的示例：

fn sum(a: i32, b: i32) -> i32 {
    let result = a + b;
    result // 最后一条语句的结果将作为返回值返回
}

函数的调用

要调用函数，可以使用函数名和传递给函数的参数。Rust 中的函数调用使用传值方式。

let a = 3;
let b = 4;
let result = sum(a, b); // 调用 sum 函数并将结果存储在 result 中

函数参数和返回值

Rust 函数的参数和返回值可以是任意类型，包括基本类型、自定义结构体、枚举和函数指针等。

struct Point {
    x: f32,
    y: f32,
}

fn get_origin() -> Point {
    Point { x: 0.0, y: 0.0 }
}

上述代码中，get_origin 函数返回一个 Point 结构体类型的实例。

函数的文档注释

Rust 支持使用文档注释来为函数提供详细的说明。文档注释使用 Markdown 格式编写，可以包含函数的使用示例、参数说明和返回值说明等。

/// 计算两个数之和
///
/// # 参数
///
/// - `a`：第一个数
/// - `b`：第二个数
///
/// # 返回值
///
/// 返回两个数的和
fn sum(a: i32, b: i32) -> i32 {
    a + b
}

总结

Rust 函数是组织代码和实现功能的重要工具。本文介绍了 Rust 函数的基本定义和语法，以及函数的调用、参数和返回值的用法。同时，还介绍了如何为函数添加详细的文档注释。通过合理地利用函数，可以使代码更具可读性、可维护性和可重用性。