document/rust-lang-zh_CN
2
0
Fork 0
mirror of https://github.com/gnu4cn/rust-lang-zh_CN.git synced 2025-03-23 07:40:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update Ch14

Browse Source
This commit is contained in:
Unisko PENG 2023-04-21 17:44:28 +08:00
parent 8a72b4d146
commit f0eee75fec
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
projects/cargo_features_demo/src/lib.rs
View File

@ -10,7 +10,7 @@
/// ``` /// ```
/// let arg = 5; /// let arg = 5;
/// let answer = cargo_features_demo::add_one(arg); /// let answer = cargo_features_demo::add_one(arg);
/// ///
/// assert_eq! (6, answer); /// assert_eq! (6, answer);
/// ``` /// ```
pub fn add_one(x: i32) -> i32 { pub fn add_one(x: i32) -> i32 {

4
src/Ch14_More_about_Cargo_and_Crates-io.md
View File

@ -95,9 +95,9 @@ pub fn add_one(x: i32) -> i32 {
} }
```` ````
*清单 14-1：一个函数的文档注释* *清单 14-1：函数的文档注释*
这里对该 `add_one` 函数完成了什么进行了描述，以标题 `示例` 开始了一个小节，随后提供了演示如何使用这个 `add_one` 函数的代码。通过运行 `cargo doc` 命令，就可以生成该文档注释的 HTML 文档。`cargo doc` 命令会运行与 Rust 一起分发的 `rustdoc` 工具，并将生成的 HTML 文档，放在 `target/doc` 目录中。 这里，咱们给到了 `add_one` 函数完成什么的描述，以标题 `示例（examples）` 开始了一个小节，并随后提供了演示怎样使用 `add_one` 函数的代码。通过运行 `cargo doc` 命令，就可以生成该文档注释的 HTML 文档。`cargo doc` 命令会运行与 Rust 一起分发的 `rustdoc` 工具，并将生成的 HTML 文档，放在 `target/doc` 目录中。
为方便起见，运行 `cargo doc --open` 将构建出当前代码箱文档（以及全部代码箱依赖的文档）的 HTML，并于随后在 web 浏览器中打开得到的结果。导航到那个 `add_one` 函数，就会看到文档注释中的文本，是如何被渲染的，如下图片 1401 中所示： 为方便起见，运行 `cargo doc --open` 将构建出当前代码箱文档（以及全部代码箱依赖的文档）的 HTML，并于随后在 web 浏览器中打开得到的结果。导航到那个 `add_one` 函数，就会看到文档注释中的文本，是如何被渲染的，如下图片 1401 中所示：