docs(course): 优化表述与修正措辞 #259
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 调整 build-system.md 中并发编译相关描述，使语义更准确 - 优化 package_management.md 对官方包管理器的介绍 - 改进 install-environment.md 关于 Zig 发布周期的说明 - 精简 hello-world.md 中 main 函数和 print 函数的说明，提升可读性 - 修改 prologue.md 中关于“为何学习 low level 语言”的表述
- 修改 0.12.0 版本说明，使语句更简洁易读 - 优化 0.13.0 版本锁实现描述，提升表达准确性 - 修正 0.14.0 版本目标修复说明中的措辞
- 将“开发命令:”修改为“开发命令：” - 修复文档末尾缺失换行符问题
- 修正多处语句表述，使语言更准确流畅 - 统一术语与格式，提升文档一致性 - 优化编辑器与安装环境相关说明，增强可读性 - 补充部分命令用法与示例，便于新手理解 - 修正部分技术细节描述，确保内容准确
- 改进整体表述，使语言更简洁易懂 - 明确区分调试与生产环境下的输出方式 - 增加对缓冲区与线程安全输出的说明 - 丰富代码解析，补充格式化字符串与参数讲解 - 补充相关提示与外部学习资源链接
- 升级 @types/node 至 24.0.10 - 升级 prettier 至 3.6.2
- 统一部分 Markdown 文件的结尾换行符 - 为列表前增加空行，提升可读性 - 保持文档风格一致，便于后续维护
- 优化数组、枚举、结构体、指针、切片、字符串、向量、联合类型等基础与高级类型文档的中文表述 - 统一术语表达，提升可读性与准确性 - 修正部分技术细节描述，使其更贴合 Zig 语言规范 - 增强示例注释，便于初学者理解 - 补充部分章节的提示与说明，完善文档结构 - 优化变量声明、错误处理、可选类型、流程控制等章节的中文表达 - 统一术语，调整部分章节标题，更符合中文技术文档习惯 - 修正部分示例代码的描述与注释 - 增强对 Zig 语言特性的解释，便于中文读者理解 - 细化零大小类型相关内容，完善类型系统介绍 - 统一“零位类型”为“零大小类型”，并补充相关示例说明 - 全面提升文档中文表达质量，便于后续维护与推广
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| > 常用于流程控制 | ||
| 在 zig 中，布尔值有两个，分别是 `true` 和 `false`，它们在内存中占用的大小为 1 个字节。 | ||
| 在 Zig 中，布尔值只有 `true` 和 `false` 两个。它们在内存中占用 1 个字节. |
There was a problem hiding this comment.
🚫 [AutoCorrect Lint] <AutoCorrect> reported by reviewdog 🐶
Suggested change
| 在 Zig 中，布尔值只有 `true` 和 `false` 两个。它们在内存中占用 1 个字节. | |
| 在 Zig 中，布尔值只有 两个。它们在内存中占用 1 个字节。占用 1 个字节. |
- 明确区分外部汇编与内联汇编两种方式 - 优化内联汇编定义，使表述更准确易懂
- 统一中文句号为全角 - 修正无序列表缩进，使用标准 markdown 语法 - 保持内容一致性，提升可读性
- 统一术语表述，如“效验和”改为“校验和” - 修正英文单词拼写错误（如 vedio→video、tunk→trunk、finisho→finish） - 优化部分语句表达，使其更通顺准确 - 补充或调整部分引用和注释内容 - 规范部分格式和标点用法
- 将“文件描述符”改为斜体以统一格式 - 优化文档可读性
- 升级 @types/node 至 24.0.10 - 升级 prettier 至 3.6.2
- 统一“三重”术语为“三元组” - 修正“tokenizer”为“标记器” - 修复“deflat e”为“deflate” - 更正“a comptime var”为“`comptime var`” - 修改“不在允许”为“不再允许” - 去除 `Compile.installHeader` 多余空格 - 修正变量名拼写错误 `dep_foor_bar` 为 `dep_foo_bar`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.