From 27b4a855d6343bfffac6177b1f7bf87a7a78068c Mon Sep 17 00:00:00 2001 From: Jesse <35264598+JesseAtSZ@users.noreply.github.com> Date: Wed, 26 Jan 2022 15:50:20 +0800 Subject: [PATCH] Update comment.md --- book/contents/advance/comment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/contents/advance/comment.md b/book/contents/advance/comment.md index 05ff24a4..5bd5fa00 100644 --- a/book/contents/advance/comment.md +++ b/book/contents/advance/comment.md @@ -76,7 +76,7 @@ pub fn add_one(x: i32) -> i32 { 以上代码有几点需要注意: -- 文档注释需要位于 `lib` 类型的包中,包根位于 `src/lib.rs` 中 +- 文档注释需要位于 `lib` 类型的包中,例如 `src/lib.rs` 中 - 文档注释可以使用 `markdown`语法!例如 `# Examples` 的标题,以及代码块高亮 - 被注释的对象需要使用 `pub` 对外可见,记住:文档注释是给用户看的,**内部实现细节不应该被暴露出去**