feat(comment-scope): 擴充審查流程痕跡規則

This commit is contained in:
2026-08-28 09:30:33 +08:00
parent 5a2d5d1bab
commit aaa0227464
3 changed files with 22 additions and 4 deletions
+14
View File
@@ -65,6 +65,18 @@
| 產生來源署名、AI 署名 | `// 本檔由 jsc-sdlc:implement 產生` |
| 外部文件連結 | `// 見 Confluence、Notion、Google Docs 連結` |
### 審查流程痕跡
這些資訊是討論當下的座標。沒有參與那場討論的人看不懂,討論結束後也會失效。註解要留下程式邏輯的原因,不留下審查流程的路徑。
| 項目 | 命中例 |
| --- | --- |
| `review`、`code review` 字樣用來描述審查流程 | `// code review 要求改成共用函式` |
| 輪次描述 | `// 第二輪追加檢查這個分支` |
| 問題與發現編號 | `// Finding1:避免空指標`、`// 問題3 已修` |
| 審查者代稱或工具名 | `// hermes 建議保留這個判斷`、`// CodeReview bot 標出這裡` |
| 審查狀態標籤 | `// 真缺陷,已解決`、`// BLOCKING` |
## 允許寫進註解
| 項目 | 允許的理由 | 例 |
@@ -87,5 +99,7 @@
| `// 見 #123` | 把 `#123` 裡的原因寫進註解本身 |
| `// @someone 2026-08-26 修` | `// 2026-08-26 改用新費率` |
| `// PLAN_A1B2C3D4 第 2 頁的規則` | 把該頁的規則正文濃縮成一句寫進來 |
| `// Finding1:避免空指標` | `// 輸入來自外部系統,空值要直接略過` |
| `// 第二輪追加這個判斷` | `// 舊資料可能缺欄位,先補預設值再解析` |
原則一句話:把編號指向的內容**搬進註解**,再刪掉編號。搬不動就代表那件事不該用註解表達,改寫進文件。