From 1e06166da4cd0c3112d1e796266787f64d745178 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8D=89=E9=9E=8B=E6=B2=A1=E5=8F=B7?= <308487730@qq.com> Date: Thu, 23 Jun 2022 09:49:26 +0800 Subject: [PATCH 1/2] chore: typo --- src/basic/comment.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/basic/comment.md b/src/basic/comment.md index 443e6a06..6ecf3f2d 100644 --- a/src/basic/comment.md +++ b/src/basic/comment.md @@ -12,11 +12,11 @@ - 文档注释,支持 `Markdown`,对项目描述、公共 API 等用户关心的功能进行介绍,同时还能提供示例代码,目标读者往往是想要了解你项目的人 - 包和模块注释,严格来说这也是文档注释中的一种,它主要用于说明当前包和模块的功能,方便用户迅速了解一个项目 -通过这些注释,实现了 Rust 极其优秀的文档化支持,甚至你还能在文档注释中写测试用例,省去了单独写测试用例的环节,我直接好家伙! +通过这些注释,实现了 Rust 极其优秀的文档化支持,甚至你还能在文档注释中写测试用例,省去了单独写测试用例的环节,我直呼好家伙! ## 代码注释 -显然之前的刮目相看是打了引号的,想要去掉引号,该写注释的时候,就老老实实的,不过写时需要遵循八字原则:**围绕目标,言简意赅**,记住,洋洋洒洒那是用来形容文章的,不是形容注释! +显然之前的刮目相看是打了引号的,想要去掉引号,该写注释的时候,就老老实实的,不过写时需要遵循八字原则:**围绕目标,言简意赅**;记住,洋洋洒洒那是用来形容文章的,不是形容注释! 代码注释方式有两种: From 73710016dd425f2640e9255bb41bf6b5d785a2cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8D=89=E9=9E=8B=E6=B2=A1=E5=8F=B7?= <308487730@qq.com> Date: Fri, 24 Jun 2022 08:44:43 +0800 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20use=20`=EF=BC=8C`=20instead=20`?= =?UTF-8?q?=EF=BC=9B`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/basic/comment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/basic/comment.md b/src/basic/comment.md index 6ecf3f2d..e15e9710 100644 --- a/src/basic/comment.md +++ b/src/basic/comment.md @@ -16,7 +16,7 @@ ## 代码注释 -显然之前的刮目相看是打了引号的,想要去掉引号,该写注释的时候,就老老实实的,不过写时需要遵循八字原则:**围绕目标,言简意赅**;记住,洋洋洒洒那是用来形容文章的,不是形容注释! +显然之前的刮目相看是打了引号的,想要去掉引号,该写注释的时候,就老老实实的,不过写时需要遵循八字原则:**围绕目标,言简意赅**,记住,洋洋洒洒那是用来形容文章的,不是形容注释! 代码注释方式有两种: