docs: 为全部代码补充中文注释并加入 AGENTS 注释规范

2026-08-13 22:09:55 +08:00
parent 812d276998
commit c1a8354282
5 changed files with 55 additions and 1 deletions
@@ -18,3 +18,10 @@ uv add faster-whisper
 ```

 Linux 上同样在 `wov-node-whisper` 目录执行 `uv add faster-whisper`；节点管理器会自动使用该仓库 `.venv/bin/python` 启动节点。
+
+## 代码注释规范
+
+- 本仓库所有源码（Python、TOML 等支持注释的文件）必须配有详细中文注释，说明模块职责、模型加载参数与 SRT 生成逻辑，确保后续维护人员可以快速理解代码工作原理。
+- 新增或修改代码时，必须同步补充或更新对应注释；不得删除已有注释。
+- 测试代码同样必须配有中文注释，说明每条测试验证的行为。
+- JSON 数据文件（`node.manifest.json`）不支持注释，字段语义以 `wov-sdk` 的 `NodeManifest` 模型注释和本文档输入/输出说明为准。