docs: 为 Tessera 本体补充中文源码注释与阅读索引 #7

Merged
Zayden-Jung merged 1 commits from codex/code-comments into main 2026-11-11 16:29:50 +00:00
Collaborator

为 Tessera 本体补充中文源码注释,让阅读者能从模块职责一路追踪到布局、刷新、发布和输入处理。代码逻辑与 Aster 子模块版本均未改变。

  • 为全部 72 个 Rust 源文件补充模块说明,并为约 790 个生产函数/方法、200 多个类型补充入口说明。
  • 进一步解释 Block/Mount 所有权、候选发布、布局/绘制续体、取消和任务交付,以及 2D 视口与 CPU 3D 的裁剪、深度和纹理映射。
  • 为内置 Endor 起始页、macOS 打包和 UML 文档脚本补充流程注释。
  • 新增 docs/code-comments.md,提供阅读顺序、关键边界与全部 77 个修改文件的逐项说明;src/README.md 增加入口。

验证:

  • cargo fmt --check 通过。
  • cargo test --locked --quiet:186 项全部通过。
  • cargo clippy --all-targets --locked -- -D warnings 通过。
  • cargo doc --locked --no-deps --document-private-items 通过。
  • sh -n scripts/build-macos-app.sh 与 node --check scripts/render-uml.mjs 通过。
  • 词法校验保留字符串字面量,确认 75 个源码/脚本文件去除注释后内容一致;git diff --check 通过。变更只有 1418 行新增,无原行删除。

范围:测试文件提供模块阅读说明,未改写测试程序文本;本次不包含性能优化,也不修改 vendor/aster。等待用户手动合并。

为 Tessera 本体补充中文源码注释,让阅读者能从模块职责一路追踪到布局、刷新、发布和输入处理。代码逻辑与 Aster 子模块版本均未改变。 - 为全部 72 个 Rust 源文件补充模块说明,并为约 790 个生产函数/方法、200 多个类型补充入口说明。 - 进一步解释 Block/Mount 所有权、候选发布、布局/绘制续体、取消和任务交付,以及 2D 视口与 CPU 3D 的裁剪、深度和纹理映射。 - 为内置 Endor 起始页、macOS 打包和 UML 文档脚本补充流程注释。 - 新增 docs/code-comments.md,提供阅读顺序、关键边界与全部 77 个修改文件的逐项说明;src/README.md 增加入口。 验证: - cargo fmt --check 通过。 - cargo test --locked --quiet:186 项全部通过。 - cargo clippy --all-targets --locked -- -D warnings 通过。 - cargo doc --locked --no-deps --document-private-items 通过。 - sh -n scripts/build-macos-app.sh 与 node --check scripts/render-uml.mjs 通过。 - 词法校验保留字符串字面量,确认 75 个源码/脚本文件去除注释后内容一致;git diff --check 通过。变更只有 1418 行新增,无原行删除。 范围:测试文件提供模块阅读说明,未改写测试程序文本;本次不包含性能优化,也不修改 vendor/aster。等待用户手动合并。
codex-bot added 1 commit 2026-11-11 15:36:54 +00:00
Zayden-Jung merged commit 0b1394e407 into main 2026-11-11 16:29:50 +00:00
Sign in to join this conversation.
No Reviewers
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Zayden-Jung/endorphin-tessera-gui#7