Skip to content

Commit 0cc9ce9

Browse files
authored
修改部分章节的标点,语序,语法等 (#79)
* modify chapter ASY, CAR, MAC, MEM, MTH for better readability * fix links in proc.md
1 parent 38d45f8 commit 0cc9ce9

File tree

15 files changed

+25
-24
lines changed

15 files changed

+25
-24
lines changed

src/safe-guides/coding_practice/async-await/G.ASY.01.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**【描述】**
66

7-
7+
在此条件下 `.await` 语句通常为必须的
88

99
**【反例】**
1010

src/safe-guides/coding_practice/async-await/G.ASY.03.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## G.ASY.03 在跨 `await` 调用中,需要对其持有 `RefCell` 的引用进行处理
22

3-
**【级别:建议**
3+
**【级别】** 建议
44

55
**【描述】**
66

src/safe-guides/coding_practice/cargo/G.CAR.01.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ bin/
2424
这样的好处有:
2525

2626
1. 便于单元测试。
27-
2. 这样拆分有利于面向接口思考,让代码架构和逻辑更加清晰。
27+
2. 有利于面向接口思考,让代码架构和逻辑更加清晰。
2828

2929
若编写的可执行程序比较复杂,在 `main.rs` 里需要依赖太多东西时,那就需要创建 Workspace 把 `main.rs` 独立为一个 crate,而在这个 crate 内也没有必要再拆分为 `main``lib` 了。
3030

src/safe-guides/coding_practice/cargo/G.CAR.02.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
**【反例】**
1111

1212
```toml
13-
# This `Cargo.toml` is missing a description field:
13+
# `Cargo.toml` 缺失介绍(description)项。无法发布到 crates.io。
1414
[package]
1515
name = "clippy"
1616
version = "0.0.212"
@@ -24,7 +24,7 @@ categories = ["development-tools", "development-tools::cargo-plugins"]
2424
**【正例】**
2525

2626
```toml
27-
# This `Cargo.toml` includes all common metadata
27+
# `Cargo.toml` 包含必要元信息。
2828
[package]
2929
name = "clippy"
3030
version = "0.0.212"

src/safe-guides/coding_practice/cargo/P.CAR.01.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66

77
但需要注意,crate 之间的依赖关系应该是单向的,避免相互依赖的情况。
88

9-
但 Rust 中 编译时间、性能、编译大小之间,在考虑优化的时候也是需要权衡的。
9+
但 Rust 中编译时间、性能、编译大小之间,在考虑优化的时候也是需要权衡的。
1010

1111
内联是优化的关键,当编译单元越大,内联优化效果就越好。所以需要权衡 crate 划分的粒度。

src/safe-guides/coding_practice/cargo/P.CAR.03.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
**【描述】**
44

5-
考虑将条件编译 `--cfg` 使用 `cargo features` 代替,使用 Rust 原生的条件编译兼容性更好些
5+
`cargo features` Rust 原生的条件编译,可用于代替 `--cfg` 参数且兼容性更好

src/safe-guides/coding_practice/macros/P.MAC.01.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**【描述】**
44

5-
能使用宏写出强大和用户友好的宏API的人,重点不仅是因为他们对宏如何实现掌握的好,而是因为他们同时也掌握了宏之外关于 Rust 的一切。
5+
当一个开发者想要能写出强大且用户友好的宏API时,不仅需要掌握如何用宏去实现,更需要掌握宏之外关于 Rust 的一切。
66

77
宏设计的重点在于宏生成什么样的代码,而不是宏如何生成代码。
88

src/safe-guides/coding_practice/macros/P.MAC.02.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**【描述】**
44

5-
Rust 宏可以让开发者定义自己的DSL,但是在使用宏的时候,要尽可能贴近Rust的语法。这样可以增强可读性,让其他开发者在使用宏的时候,可以猜测出它的生成的代码
5+
Rust 宏可以让开发者定义自己的 DSL,但是在使用宏的时候,要尽可能贴近 Rust 的语法。这样可以增强可读性,让其他开发者在使用宏的时候,可以猜测出它生成的代码
66

77
**【反例】**
88

src/safe-guides/coding_practice/macros/decl/P.MAC.DCL.03.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**【描述】**
44

5-
`macro_rules!` 定义声明宏时,非终止的元变量匹配必须紧随一个已被决定可以在这种匹配之后安全使用的标记
5+
`macro_rules!` 定义声明宏时,非终止的元变量匹配必须紧随一个已被决定能在这种匹配之后安全使用的标记
66

77
具体的规则参见:[Follow-set Ambiguity Restrictions](https://doc.rust-lang.org/reference/macros-by-example.html#follow-set-ambiguity-restrictions)
88

src/safe-guides/coding_practice/macros/decl/P.MAC.DCL.05.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**【描述】**
44

5-
使用宏替换(substitution)元变量,就是指把已经进行过宏解析的 token 再次传给宏,需要注意,此时传入的 token已经被看作是宏解析器解析后的 AST 节点了。
5+
使用宏替换(substitution)元变量,就是指把已经进行过宏解析的 token 再次传给宏,需要注意此时传入的 token 已经被看作是宏解析器解析后的 AST 节点了。
66

77
片段分类符介绍([fragment-specifier](https://doc.rust-lang.org/nightly/reference/macros-by-example.html#metavariables)
88

0 commit comments

Comments
 (0)