docs: 更新注释规范和语言规范，强调使用 Google DocStr 格式和简体中文

2026-03-22 01:04:29 +08:00
parent 89df7ccf6b
commit a0c653de45
1 changed files with 5 additions and 0 deletions
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -17,6 +17,7 @@
 1. 尽量保持良好的注释
 2. 如果原来的代码中有注释，则重构的时候，除非这部分代码被删除，否则相同功能的代码应该保留注释（可以对注释进行修改以保持准确性，但不应该删除注释）。
 3. 如果原来的代码中没有注释，则重构的时候，如果某个功能块的代码较长或者逻辑较为复杂，则应该添加注释来解释这部分代码的功能和逻辑。
+4. 对于类，方法以及模块的注释，首选使用的注释格式为 Google DocStr 格式，但保证语言为简体中文
 ## 类型注解规范
 1. 重构代码时，如果原来的代码中有类型注解，则相同功能的代码应该保留类型注解（可以对类型注解进行修改以保持准确性，但不应该删除类型注解）。
 2. 重构代码时，如果原来的代码中没有类型注解，则重构的时候，如果某个函数的功能较为复杂或者参数较多，则应该添加类型注解来提高代码的可读性和可维护性。（对于简单的变量，可以不添加类型注解）
@@ -35,3 +36,7 @@
 # 运行/调试/构建/测试/依赖
 优先使用uv
 依赖项以 pyproject.toml 为准
+
+# 语言规范
+
+项目的首选语言为简体中文，无论是注释语言，日志展示语言，还是 WebUI 展示语言都应该首要以简体中文为首要实现目标