# 使用 Rust 的基本工具链

URL: https://caijiao.org/rust/02-setup/03-toolchain
Source: docs/rust/02-setup/03-toolchain.md
Description: Rust 提供丰富的基本工具链，包括编译器 rustc、包管理器 cargo、文档生成器 rustdoc 和测试工具，构建现代软件项目高效可靠。

Rust 安装后会附带一整套官方工具链，帮助开发者高效完成开发、构建、测试与发布流程。

## `rustc`：Rust 编译器

`rustc` 是 Rust 官方编译器，用于将 `.rs` 文件编译为二进制程序：

```bash
rustc main.rs
./main  # 运行编译结果
```

虽然可以直接使用 `rustc`，但在项目开发中我们更常使用 `cargo` 来管理构建流程。

## `cargo`：构建与包管理工具

`cargo` 是 Rust 的核心工具，集成了依赖管理、构建、测试和运行等功能。

常用命令如下：

```bash
cargo new my_project       # 创建新项目
cd my_project
cargo build                # 构建项目
cargo run                  # 编译并运行
cargo check                # 仅做语法检查（更快）
cargo test                 # 运行测试
cargo doc --open           # 生成并打开文档
```

项目结构：

```
my_project/
├── Cargo.toml   # 项目信息与依赖配置
└── src/
    └── main.rs  # 项目入口
```

## `rustdoc`：文档生成工具

Rust 提供内建文档系统，通过注释和 `rustdoc` 自动生成 API 文档：

```bash
cargo doc --open
```

文档采用 Markdown 语法注释，例如：

```rust
/// 计算两个数的和
fn sum(a: i32, b: i32) -> i32 {
    a + b
}
```

## 其他组件

- `rustfmt`：代码格式化工具
  安装：`rustup component add rustfmt`
  使用：`cargo fmt`

- `clippy`：静态代码检查工具
  安装：`rustup component add clippy`
  使用：`cargo clippy`

---

Rust Playground 示例代码