🎨 style(markdown): format all markdown files with prettier

- 使用 prettier 格式化所有 markdown 文件
- prose-wrap: always, print-width: 80
- 保持代码块和表格格式
- 提升可读性和一致性

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
csh
2026-01-07 17:18:01 +08:00
co-authored by Claude Sonnet 4.5
parent 7e96bc86d8
commit 99bef309b7
86 changed files with 1858 additions and 981 deletions
+14 -6
View File
@@ -22,7 +22,8 @@ cpp/
### 1.2 文件扩展名约定
- 头文件:`.h`Google 风格;若项目已统一 `.hpp`,以项目既有为准)
- 源文件:`.cc`(优先;`main` 入口建议使用 `main.cc`;若项目已统一 `.cpp`,以项目既有为准)
- 源文件:`.cc`(优先;`main` 入口建议使用 `main.cc`;若项目已统一
`.cpp`,以项目既有为准)
- Module Interface Unit`.cppm`(推荐统一)
- Module Partition`.cppm`(在文件名中体现分区,例如 `foo_part.cppm`
@@ -31,9 +32,13 @@ cpp/
- Module 名称建议使用“点分层级”组织,且每一段使用 `lower_snake_case`
- 示例:`my_project.net.http`
- 文件路径与 module 名建议可映射(便于检索):
- `cpp/modules/my_project/net/http.cppm` `export module my_project.net.http;`
- 避免在同一模块内混用“头文件边界”和“模块边界”造成可见性混乱;对外 API 优先通过 `export` 暴露。
- 工程约束:新增/删除/重命名 `.cppm`(或变更 `export module ...`)时,必须同步更新构建系统的模块清单(例如 CMake 的 `target_sources(FILE_SET CXX_MODULES ...)`),否则容易出现“本地能编、CI/他人机器不能编”的漂移。
- `cpp/modules/my_project/net/http.cppm`
`export module my_project.net.http;`
- 避免在同一模块内混用“头文件边界”和“模块边界”造成可见性混乱;对外 API 优先通过
`export` 暴露。
- 工程约束:新增/删除/重命名 `.cppm`(或变更
`export module ...`)时,必须同步更新构建系统的模块清单(例如 CMake 的
`target_sources(FILE_SET CXX_MODULES ...)`),否则容易出现“本地能编、CI/他人机器不能编”的漂移。
## 2. 格式(Formatting
@@ -42,7 +47,8 @@ cpp/
- 本仓库/标准默认:`clang-format` + Google 风格。
- 建议在项目根目录提供 `.clang-format` 并纳入 CI/本地钩子。
- 列宽建议与本 Playbook 其他语言保持一致:默认 100(可按项目调整,但要全仓一致)。
- 模板:`templates/cpp/.clang-format`(参考 `tsl-devkit/lsp-server/.clang-format` 并做了最小化泛化)。
- 模板:`templates/cpp/.clang-format`(参考
`tsl-devkit/lsp-server/.clang-format` 并做了最小化泛化)。
### 2.2 通用格式约定
@@ -67,6 +73,8 @@ cpp/
## 5. Windows 支持
- 本规范假设 **不做原生 Windows 开发环境支持**Windows 产物通过 **Linux 上的 Clang 交叉编译工具链**获得(工具链路径/三元组等由项目的 Conan profile 或 toolchain 文件定义)。
- 本规范假设 **不做原生 Windows 开发环境支持**Windows 产物通过
**Linux 上的 Clang 交叉编译工具链**获得(工具链路径/三元组等由项目的 Conan
profile 或 toolchain 文件定义)。
- 如需条件编译,优先用标准特性检测与最小化条件编译,并写清动机(例如 ABI/平台差异)。
- 对路径、换行、编码、大小写敏感等行为要明确约束并在文档/测试中覆盖。