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

2026-08-20 09:21:07 +08:00
parent 54c21876e4
commit d8da9c7b1a
7 changed files with 10 additions and 10 deletions
@@ -50,7 +50,7 @@

 ### 2.5 注释

- 默认不写注释；只在 WHY 不明显时写一行；不写解释 WHAT 的注释（命名应自解释）。
+- 每个方法必须写注释（一行职责说明，复杂方法补充入参/出参/边界，便于人工复核）；只在 WHY 不明显处补充 WHY 注释；不写会随时间失效的注释。

 ## 3. 提交规范