Skip to content

Commit 26c6ee3

Browse files
committed
docs: fix typo
1 parent 39aa91f commit 26c6ee3

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

codes/rust/GUIDELINES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 工具准备
44

5-
[Clippy] 是 Rust 工具链中的可选组件,可以帮助我们发现和修复代码中的常见问题。请确保在提交代码之前运行 Clippy并修复所有警告。
5+
[Clippy] 是 Rust 工具链中的可选组件,可以帮助我们发现和修复代码中的常见问题。请确保在提交代码之前运行 Clippy 并修复所有警告。
66

77
### 安装
88

@@ -38,7 +38,7 @@ cargo clippy
3838

3939
- **公共项**:应作为本项目的同名库 crate `hello_algo_rust` 的公共接口,放在 `src` 目录下。项目内的其他所有代码均为二进制 crate,它们作为依赖链的最下游,不应作为依赖项被其他 crate「挂载」为模块。目前 Cargo 并没有阻止这种做法,甚至允许一个文件被多次「挂载」,但这是一种典型的反模式,应当避免。
4040

41-
- **可见性****示例代码**全部位于 bin crate,原则上不会被其他地方使用,最大可见性本应为 `pub(crate)`,在 crate 顶层无需被可见性修饰符修饰;然而,「实现某种数据结构或算法」暗示着代码将作为某种公开接口供下游使用,为了表达这种意图,以及区分公开接口和内部实现细节,**示例代码**中原则上是公开接口的部分应使用 `pub` 修饰符,是内部实现细节的部分不使用可见性修饰符。可见性修饰符中不得范围参数,例如 `pub(super)``pub(in some::path)` 等。
41+
- **可见性****示例代码**全部位于 bin crate,原则上不会被其他地方使用,最大可见性本应为 `pub(crate)`,在 crate 顶层无需被可见性修饰符修饰;然而,「实现某种数据结构或算法」暗示着代码将作为某种公开接口供下游使用,为了表达这种意图,以及区分公开接口和内部实现细节,**示例代码**中原则上是公开接口的部分应使用 `pub` 修饰符,是内部实现细节的部分不使用可见性修饰符。可见性修饰符中不得出现范围参数,例如 `pub(super)``pub(in some::path)` 等。
4242

4343
- **导入**:常量、静态量、类型别名、结构体、枚举、trait 等可直接导入,函数应导入上级模块并以其为前缀使用。
4444

0 commit comments

Comments
 (0)