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

2026-08-13 22:09:55 +08:00
parent 0a028bedcc
commit 94c7867c5a
7 changed files with 92 additions and 0 deletions
@@ -13,3 +13,9 @@
 - 页面不直接暴露 API 调用细节给普通用户。
 - 前端只通过 `/api/...` 调用后端，不内联业务逻辑。
 - 后续迁移到 React 时，页面行为应与当前静态页面保持一致。
+
+## 代码注释规范
+
+- 本仓库所有源码（HTML、JavaScript、CSS 等支持注释的文件）必须配有详细中文注释，说明页面职责、函数作用与关键交互逻辑，确保后续维护人员可以快速理解代码工作原理。
+- 新增或修改代码时，必须同步补充或更新对应注释；不得删除已有注释。
+- 每个 HTML 页面需要在文件头说明页面用途；公共脚本需要说明各函数的职责。