Update comment.md

3 years ago · 27b4a855d6
parent 5648aecc53
commit 27b4a855d6
1 changed files with 1 additions and 1 deletions
--- 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` 对外可见，记住：文档注释是给用户看的，**内部实现细节不应该被暴露出去**