From 4263f2af563a75084bdf664f01811397e0b1e973 Mon Sep 17 00:00:00 2001 From: Daniel Date: Fri, 16 Jul 2021 11:03:05 +0800 Subject: [PATCH] Update ch14-02-publishing-to-crates-io.md --- src/ch14-02-publishing-to-crates-io.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ch14-02-publishing-to-crates-io.md b/src/ch14-02-publishing-to-crates-io.md index 2f3e336..463670f 100644 --- a/src/ch14-02-publishing-to-crates-io.md +++ b/src/ch14-02-publishing-to-crates-io.md @@ -65,7 +65,7 @@ test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out #### 注释包含项的结构 -还有另一种风格的文档注释，`//!`，这为包含注释的项，而不是位于注释之后的项增加文档。这通常用于 crate 根文件（通常是 _src/lib.rs_）或模块的根文件为 crate 或模块整体提供文档。 +还有另一种风格的文档注释，`//!`，为包含注释的项添加文档，而不是为注释之后的项增加文档。通常用于 crate 根文件（通常是 *src/lib.rs*）或模块的根文件，为 crate 或模块整体提供文档。 作为一个例子，如果我们希望增加描述包含 `add_one` 函数的 `my_crate` crate 目的的文档，可以在 _src/lib.rs_ 开头增加以 `//!` 开头的注释，如示例 14-2 所示：