mirror of
https://github.com/gnu4cn/rust-lang-zh_CN.git
synced 2025-03-27 04:21:37 +08:00
Update Ch14
This commit is contained in:
parent
8c5c8bad81
commit
2488bb92b3
@ -5,7 +5,7 @@
|
||||
//!
|
||||
|
||||
/// 将一加到所给数字。
|
||||
/// # 示例(examples)
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// let arg = 5;
|
||||
|
@ -82,7 +82,7 @@ Rust 与 Cargo,均有着令到咱们所发布的包,易于为他人找到并
|
||||
|
||||
````rust
|
||||
/// 将一加到所给数字。
|
||||
/// # 示例(examples)
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// let arg = 5;
|
||||
@ -97,7 +97,7 @@ pub fn add_one(x: i32) -> i32 {
|
||||
|
||||
*清单 14-1:函数的文档注释*
|
||||
|
||||
这里,咱们给到了 `add_one` 函数完成什么的描述,以标题 `示例(examples)` 开始了一个小节,并随后提供了演示怎样使用 `add_one` 函数的代码。咱们可通过运行 `cargo doc` 命令,生成文档注释的 HTML 文档。这个命令会运行与 Rust 一起分发的 `rustdoc` 工具,并将生成的 HTML 文档放在 `target/doc` 目录中。
|
||||
这里,咱们给到了 `add_one` 函数完成什么的描述,以标题 `Examples` 开始了一个小节,并随后提供了演示怎样使用 `add_one` 函数的代码。咱们可通过运行 `cargo doc` 命令,生成文档注释的 HTML 文档。这个命令会运行与 Rust 一起分发的 `rustdoc` 工具,并将生成的 HTML 文档放在 `target/doc` 目录中。
|
||||
|
||||
处于便利目的,运行 `cargo doc --open` 将构建出当前代码箱文档(以及咱们代码箱全部依赖的文档)的 HTML,并随后在 web 浏览器中打开得到的结果。导航到那个 `add_one` 函数,咱们将看到文档注释中的文本如何渲染出来,如下图片 14-01 中所示:
|
||||
|
||||
@ -109,7 +109,7 @@ pub fn add_one(x: i32) -> i32 {
|
||||
|
||||
**Commonly Used Sections**
|
||||
|
||||
这里用到了清单 14-1 中 `# 示例(examples)` 的 Markdown 标题,来创建出生成 HTML 中,有着标题 “示例(examples)” 的一个小节。下面是代码箱编写者经常在他们文档中,用到的一些别的小节:
|
||||
咱们曾使用清单 14-1 中的 `# Examples` Markdown 标题,来创建出 HTML 中带有标题 “Examples” 的小节。下面是代码箱作者们,经常在他们文档中用到的一些其他小节:
|
||||
|
||||
- **终止运行(Panics)**:正被文档注释的函数可能终止运行的情形。不愿他们的程序终止运行的那些调用者,应确保他们不会在这些情形下调用该函数;
|
||||
- **报错(Errors)**:在该函数返回的是一个 `Result` 时,那么对可能发生的各种错误及何种条件下会引起这些错误被返回进行描述,就能有效帮助到调用者,以便他们可以编写出以不同方式,处理这些不同类别错误的代码来。
|
||||
|
Loading…
Reference in New Issue
Block a user