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

2026-08-20 09:21:07 +08:00
parent 54c21876e4
commit d8da9c7b1a
7 changed files with 10 additions and 10 deletions
@@ -432,8 +432,8 @@ public DaoIdGenerator jcBillIdGenerator() {

 ### 8.2 代码风格

- Java：4 空格缩进、行宽 ≤ 120；**默认不写注释**，仅在 WHY 不明显处写一行注释。
- TS/Vue：遵循框架现有风格；组件选项式 `name` + `<script setup>` 组合。
+- Java：4 空格缩进、行宽 ≤ 120；**每个方法必须写注释**（一行职责说明，复杂方法补充入参/出参/边界条件），便于人工复核；只在 WHY 不明显处补充 WHY 注释。
+- TS/Vue：遵循框架现有风格；组件选项式 `name` + `<script setup>` 组合；**每个方法/函数必须写一行职责注释**（`//` 或 JSDoc），便于人工复核。
 - 命名：动词+名词、语义明确；禁语义空名（见 §4.2）。

 ### 8.3 评审约定