Commit 6ca9ea8
authored
docs(course): 优化表述与修正措辞 (#259)
* docs(course): 优化表述与修正措辞
- 调整 build-system.md 中并发编译相关描述,使语义更准确
- 优化 package_management.md 对官方包管理器的介绍
- 改进 install-environment.md 关于 Zig 发布周期的说明
- 精简 hello-world.md 中 main 函数和 print 函数的说明,提升可读性
- 修改 prologue.md 中关于“为何学习 low level 语言”的表述
* style(update): 优化发行说明表述
- 修改 0.12.0 版本说明,使语句更简洁易读
- 优化 0.13.0 版本锁实现描述,提升表达准确性
- 修正 0.14.0 版本目标修复说明中的措辞
* docs(readme): 修正文档标点和格式
- 将“开发命令:”修改为“开发命令:”
- 修复文档末尾缺失换行符问题
* feat(docs): 优化基础类型与环境配置文档表达
- 修正多处语句表述,使语言更准确流畅
- 统一术语与格式,提升文档一致性
- 优化编辑器与安装环境相关说明,增强可读性
- 补充部分命令用法与示例,便于新手理解
- 修正部分技术细节描述,确保内容准确
* feat(course): 优化 hello world 教程内容与表达
- 改进整体表述,使语言更简洁易懂
- 明确区分调试与生产环境下的输出方式
- 增加对缓冲区与线程安全输出的说明
- 丰富代码解析,补充格式化字符串与参数讲解
- 补充相关提示与外部学习资源链接
* chore(deps): 更新依赖版本
- 升级 @types/node 至 24.0.10
- 升级 prettier 至 3.6.2
* docs(basic): 修正文档格式与空行一致性
- 统一部分 Markdown 文件的结尾换行符
- 为列表前增加空行,提升可读性
- 保持文档风格一致,便于后续维护
* docs(basic): 优化基础类型与高级类型章节中文表述
- 优化数组、枚举、结构体、指针、切片、字符串、向量、联合类型等基础与高级类型文档的中文表述
- 统一术语表达,提升可读性与准确性
- 修正部分技术细节描述,使其更贴合 Zig 语言规范
- 增强示例注释,便于初学者理解
- 补充部分章节的提示与说明,完善文档结构
- 优化变量声明、错误处理、可选类型、流程控制等章节的中文表达
- 统一术语,调整部分章节标题,更符合中文技术文档习惯
- 修正部分示例代码的描述与注释
- 增强对 Zig 语言特性的解释,便于中文读者理解
- 细化零大小类型相关内容,完善类型系统介绍
- 统一“零位类型”为“零大小类型”,并补充相关示例说明
- 全面提升文档中文表达质量,便于后续维护与推广
* feat(advanced): 优化 Zig 汇编方式与内联汇编表述
- 明确区分外部汇编与内联汇编两种方式
- 优化内联汇编定义,使表述更准确易懂
* style: 修正文档标点和列表格式
- 统一中文句号为全角
- 修正无序列表缩进,使用标准 markdown 语法
- 保持内容一致性,提升可读性
* fix(docs): 修正文档中的错别字与表述不当
- 统一术语表述,如“效验和”改为“校验和”
- 修正英文单词拼写错误(如 vedio→video、tunk→trunk、finisho→finish)
- 优化部分语句表达,使其更通顺准确
- 补充或调整部分引用和注释内容
- 规范部分格式和标点用法
* docs(examples): 修正 I/O 多路复用描述中的格式
- 将“文件描述符”改为斜体以统一格式
- 优化文档可读性
* chore(deps): 更新开发依赖版本
- 升级 @types/node 至 24.0.10
- 升级 prettier 至 3.6.2
* fix(update): 修正文档错别字与术语不一致
- 统一“三重”术语为“三元组”
- 修正“tokenizer”为“标记器”
- 修复“deflat e”为“deflate”
- 更正“a comptime var”为“`comptime var`”
- 修改“不在允许”为“不再允许”
- 去除 `Compile.installHeader` 多余空格
- 修正变量名拼写错误 `dep_foor_bar` 为 `dep_foo_bar`1 parent 016c192 commit 6ca9ea8
File tree
40 files changed
+623
-636
lines changed- course
- advanced
- basic
- advanced_type
- basic_type
- process_control
- engineering
- environment
- examples
- update
40 files changed
+623
-636
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
48 | | - | |
| 48 | + | |
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
| 64 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
10 | | - | |
| 9 | + | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| |||
204 | 204 | | |
205 | 205 | | |
206 | 206 | | |
207 | | - | |
| 207 | + | |
208 | 208 | | |
209 | 209 | | |
210 | 210 | | |
| |||
548 | 548 | | |
549 | 549 | | |
550 | 550 | | |
551 | | - | |
| 551 | + | |
552 | 552 | | |
553 | 553 | | |
554 | 554 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| |||
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
50 | | - | |
| 50 | + | |
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
| 29 | + | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | | - | |
| 43 | + | |
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
| 47 | + | |
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
51 | | - | |
| 51 | + | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
| 65 | + | |
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
71 | | - | |
| 71 | + | |
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
76 | 76 | | |
77 | | - | |
| 77 | + | |
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
83 | | - | |
| 83 | + | |
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
87 | | - | |
| 87 | + | |
88 | 88 | | |
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
92 | 92 | | |
93 | | - | |
| 93 | + | |
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
97 | | - | |
| 97 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
| 27 | + | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | | - | |
| 41 | + | |
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
| 47 | + | |
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| |||
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
71 | | - | |
| 71 | + | |
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
76 | 76 | | |
77 | | - | |
| 77 | + | |
78 | 78 | | |
79 | | - | |
| 79 | + | |
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
83 | | - | |
| 83 | + | |
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
87 | | - | |
| 87 | + | |
88 | 88 | | |
89 | | - | |
| 89 | + | |
90 | 90 | | |
91 | 91 | | |
92 | 92 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
19 | | - | |
| 19 | + | |
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| |||
0 commit comments