3 Commits
Author SHA1 Message Date
jiantw83andClaude Opus 5 87e4555a90 docs(comment-scope): 色碼列進允許項,不再當編號看
「允許寫進註解」那張表加一列:十六進位色碼。理由寫在同一列——它指的是顏
色,不是編號;只有純十進位的才當議題編號看。

守門腳本那一邊已經多剪一條,把井號後面含十六進位字母的色碼先剪掉。正文
是規則的唯一真實來源,腳本剪了一條而正文不動,下一個讀正文的人會以為色
碼仍然違規,於是把註解裡的色碼手動刪掉,或反過來覺得腳本放水。兩邊對不
起來,規則就沒有人信。

補的是一列,不是一段。既有六列的欄位次序照舊,允許項、理由、範例三格都
填滿,範例挑樣式表註解裡標主色那種常見寫法,讀的人一眼看得出這條規則在
講哪種場景。

影響註解範圍的判準本身,也就是所有讀這份正文的人與所有引用它的技能:註
解裡寫色碼從此明文放行,議題編號、需求編號那些照舊禁止。

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-08 15:04:21 +08:00
jiantw83 aaa0227464 feat(comment-scope): 擴充審查流程痕跡規則 2026-08-28 09:30:33 +08:00
jiantw83 fd70ce3bc2 feat(review): 新增程式碼註解禁止夾帶文件資訊的規則正文
What:新增 references/comment-scope.md 規則正文,並在 references/smells.md
第 2 組加入 2.5 文件編號夾帶,嚴重度分級「低」列補上本項。

Why:註解寫「這件事記在哪份文件」,讀程式碼的人查不到。編號會過期、會搬家、
會落在存取權限外,最後只剩一串無意義的代號。註解該寫的是「為什麼這樣寫」。

How:規則正文限定適用範圍只到程式碼註解,docstring、README、commit 訊息不受限。
禁止清單三十項分四組:追蹤系統編號、jsc wiki 頁面編號、需求與規格編號、
流程與人事資訊。白名單七項:日期與時間戳、需求變更歷程、RFC 與 ISO 標準、CVE、
第三方套件 issue 連結、授權標頭與 SPDX、語言原生標記。

Who:jsc-review 的 code-review 技能,第 2 組可讀性審查。
2026-08-26 19:00:38 +08:00