02-Playground

译文 · 基于 Rust By Example

原文链接: https://doc.rust-lang.org/stable/rust-by-example/meta/playground.html

Playground

Rust Playpen 是一个在线运行 Rust 代码的网络接口。现在该项目通常称为 Rust Playground。

在 mdbook 使用

在 mdbook 中，你可以让示例代码运行和编辑。

1
2
3

fn main() {
    println!("Hello World!");
}

这使读者既可以运行你的代码示例，也可以对其进行修改和调整。此处的关键是将单词添加 editable 到代码块中，并用逗号分隔。

1
2
3

```rust,editable
//...将你的代码写在这里
```

此外，如果想要 mdbook 在构建和测试时跳过该代码，则可以添加 ignore。

1
2
3

```rust,editable,ignore
//...将你的代码写在这里
```

在文档中使用

可能你已经在某些 Rust 官方文档中注意到了一个名为 “Run” 的按钮，该按钮在 Rust Playground 的新选项卡中打开了代码示例。如果使用名为的 html_playground_url 的 #[doc] 属性，则启用此功能。

参见：

• The Rust Playground
• 下一代 playpen
• 官方文档