Update Ch14

This commit is contained in:
Peng Hailin, 2023-04-21 19:18:26 +08:00
parent f0eee75fec
commit 8c5c8bad81

View File

@ -97,15 +97,17 @@ pub fn add_one(x: i32) -> i32 {
*清单 14-1函数的文档注释*
这里,咱们给到了 `add_one` 函数完成什么的描述,以标题 `示例examples` 开始了一个小节,并随后提供了演示怎样使用 `add_one` 函数的代码。通过运行 `cargo doc` 命令,就可以生成该文档注释的 HTML 文档。`cargo doc` 命令会运行与 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` 函数,就会看到文档注释中的文本,是如何被渲染的,如下图片 1401 中所示:
处于便利目的,运行 `cargo doc --open` 将构建出当前代码箱文档(以及咱们代码箱全部依赖的文档)的 HTML并随后在 web 浏览器中打开得到的结果。导航到那个 `add_one` 函数,咱们将看到文档注释中的文本如何渲染出来,如下图片 14-01 中所示:
![`add_one` 函数的 HTML 文档](images/14-01.png)
*图 14-01`add_one` 函数的 HTML 文档*
#### 经常用到的一些小节
#### 经常用到的小节
**Commonly Used Sections**
这里用到了清单 14-1 中 `# 示例examples` 的 Markdown 标题,来创建出生成 HTML 中,有着标题 “示例examples” 的一个小节。下面是代码箱编写者经常在他们文档中,用到的一些别的小节: