docs: 注释约定改为每方法必写（便于人工复核）

2026-08-20 09:21:07 +08:00
parent 54c21876e4
commit d8da9c7b1a
7 changed files with 10 additions and 10 deletions
@@ -42,8 +42,8 @@
 - 派生文档发现与上游不一致 → 回去改上游，不能让派生文档自走

 ### B4. 注释与命名
- 默认不写注释；只在 WHY 不明显时写一行。
- 不写解释 WHAT 的注释（命名应自解释）。
+- 每个方法/函数必须写注释（一行职责说明，便于人工复核）。
+- 只在 WHY 不明显处补充 WHY 注释；不写会随时间失效的注释。
 - 不写"为某 issue/任务而加"这类会随时间失效的注释。
 - 严格遵守 `CONVENTIONS.md` 中的命名规范（不存在则先补）。