From 8a72b4d1464507d3346406b94f39317862e96ee3 Mon Sep 17 00:00:00 2001 From: Unisko PENG Date: Fri, 21 Apr 2023 17:35:12 +0800 Subject: [PATCH] Update Ch14 --- src/Ch14_More_about_Cargo_and_Crates-io.md | 6 +++--- src/Ch21_Appendix.md | 4 ++++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/Ch14_More_about_Cargo_and_Crates-io.md b/src/Ch14_More_about_Cargo_and_Crates-io.md index a53ef32..c90db5b 100644 --- a/src/Ch14_More_about_Cargo_and_Crates-io.md +++ b/src/Ch14_More_about_Cargo_and_Crates-io.md @@ -70,13 +70,13 @@ opt-level = 1 Rust 与 Cargo，均有着令到咱们所发布的包，易于为他人找到并使用的一些特性。咱们将讲到其中一些特性，并讲解怎样发布包，how to publish a package。 -### 制作一些有用的文档注释 +### 制作有用的文档注释 **Making Useful Documentation Comments** -准确地为咱们的包编写文档，将帮助到其他使用者获悉怎样及何时来使用咱们的包，因此投入时间来编写文档是值得的。第 3 章中，就曾讨论过如何使用双斜杠 `//`，来注释 Rust 代码。Rust 还有用于文档的一种特殊注释，通常被称作 *文档注释（documentation comment）*，此类注释将产生出 HTML 文档。这些生成的 HTML，会将给那些想要了解怎样 *使用（use）* 咱们的代码箱，而不是咱们代码箱如何实现的程序员，准备的公开 API 的文档注释，给显示出来。 +准确地为咱们的包编写文档，将帮助到其他使用者获悉怎样及何时来使用他们，因此投入时间来编写文档是值得的。第 3 章中，咱们曾讨论过如何使用双斜杠 `//`来注释 Rust 代码。Rust 还有用于文档的一种将生成 HTML 文档的特殊注释，而被方便地称作 *文档注释，documentation comment*。这些 HTML 会显示出公开 API 项目的文档注释内容，这些内容是为对了解怎样 *使用，use* 咱们的代码箱，而非咱们代码箱如何实现感兴趣的程序员所准备的。 -文档注释用的是三斜杠 `///`，而不是双斜杠，并支持用于格式化文本的 Markdown 写法。要把文档注释，放在他们要注释项目之前，紧接着注释项目。下面清单 14-1 给出了名为 `cargo_features_demo` 代码箱中，一个 `add_one` 函数的文档注释。 +文档注释用的是三斜杠 `///` 而非双斜杠，并支持用于格式化文本的 Markdown 写法。要把文档注释恰好放在他们要注释的项目前，而紧接着注释项目。下面清单 14-1 给出了名为 `cargo_features_demo` 代码箱中，`add_one` 函数的文档注释。 文件名：`src/lib.rs` diff --git a/src/Ch21_Appendix.md b/src/Ch21_Appendix.md index 72228c0..34af8b9 100644 --- a/src/Ch21_Appendix.md +++ b/src/Ch21_Appendix.md @@ -786,6 +786,10 @@ $ rustup component add llvm-tools-preview ## 附录 I - 术语清单 +- 文档注释 + +Documentation comment, 将产生出 HTML 的注释。 + - 单态化