What:references/smells.md 第 5 組擴充。5.1 的方法描述後面要接條列式的處理步驟 與規則,5.3 的回傳值是自訂資料模型時要附上型別定義的導向連結;新增 5.6 內含 功能的導向連結、5.7 XML 註解標籤各占一行、5.8 註解裡的專有名詞與變數依語言 慣例標示。文末的嚴重度分級補上一張表,逐項標明這五個新項目的級別與理由。 Why:使用者提出的產出物文件品質規則裡,有三條講的都是原始碼註解要寫到什麼 程度。動手前先比對過既有內容,第 5 組已經涵蓋大部分,缺的是條列步驟、導向 連結與標示語法這三塊。另開一支技能會跟 code-review 的目標重疊,所以直接擴充 第 5 組。新項目多半屬於可讀性層級,混在原本「註解缺漏」一句話裡分不出輕重, 所以級別另外列。 How:5.1 與 5.3 在原有定義後面接上新要求,偵測訊號與建議重構手法同步補列, 原本的判準一個都不動。5.6 到 5.8 照既有小節的四段結構寫:定義、偵測訊號、 建議重構手法、注意事項。5.8 的標示語法用表格對照 XML 與 JSDoc、docstring 兩類格式。5.6 與 5.7 都寫明註解格式不支援時不適用,避免硬造連結字串,也避免 把 XML 的排版規則套到沒有結束標籤的格式上。 Who:jsc-review 的壞味道參考清單,第 5 組註解契約。
jsc-review — 程式碼審查
jsc 技能組的 review domain:基於《Refactoring》壞味道目錄的六組審查(結構與體積、可讀性與命名、耦合與設計、邏輯與壞習慣、註解規範、淺模組),套用在檔案變更完成與實作完成兩個時機。
安裝、更新、移除
Marketplace 統一為 jsc(https://gitea.jsc.idv.tw/plugins/meta.git),安裝 token 為 jsc-review@jsc。每個指令一行:
| CLI | 安裝 | 更新 | 移除 |
|---|---|---|---|
| claude | claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/meta.git && claude plugin install jsc-review@jsc |
claude plugin marketplace update jsc && claude plugin update jsc-review@jsc |
claude plugin uninstall jsc-review@jsc |
| codex | codex plugin marketplace add https://gitea.jsc.idv.tw/plugins/meta.git && codex plugin add jsc-review@jsc |
codex plugin marketplace upgrade jsc |
codex plugin remove jsc-review@jsc |
| copilot | copilot plugin marketplace add https://gitea.jsc.idv.tw/plugins/meta.git && copilot plugin install jsc-review@jsc |
copilot plugin marketplace update jsc && copilot plugin update jsc-review@jsc |
copilot plugin uninstall jsc-review@jsc |
| antigravity | git clone https://gitea.jsc.idv.tw/plugins/review.git ~/plugins/review && agy plugin install ~/plugins/review |
git -C ~/plugins/review pull && agy plugin uninstall jsc-review && agy plugin install ~/plugins/review |
agy plugin uninstall jsc-review |
| kiro | kiro-cli plugin marketplace add https://gitea.jsc.idv.tw/plugins/meta.git && kiro-cli plugin install jsc-review@jsc |
kiro-cli plugin marketplace update jsc && kiro-cli plugin update jsc-review@jsc |
kiro-cli plugin uninstall jsc-review@jsc |
antigravity 不支援 gitea URL 安裝,改用本地 clone 路徑。批次操作五個 CLI:使用
/jsc-cli:deploy。
舊入口
plugins/jsc已移除,marketplace 正本移到plugins/meta。marketplace 名稱仍是jsc(取自 marketplace.json 的name欄位,與存取庫名無關),安裝 token 不變;已從舊入口安裝過的人先執行claude plugin marketplace remove jsc,再依上表重新 add。
Skills 目錄
呼叫方式:Claude / Antigravity /jsc-review:{name};Codex ${name};Copilot / Kiro 描述需求自動觸發。
code-review
對 git diff 進行六組壞味道審查,每組一個 sub agent 平行執行;回報 檔案:行號、嚴重度、建議重構手法,修正與否由呼叫端決定。第 2 組同時擋「文件編號夾帶」:註解只寫「為什麼這樣寫」,議題編號、wiki 頁編號、工作包編號、commit hash、@ 提及、外部文件連結一律不進註解,清單看 references/comment-scope.md。diff 是空的就直接回報「無發現」,不開任何 sub agent;六組全部回覆才進入彙整,沒東西可報的那組也要回「無發現」。安全性與 bug 審查交給 CLI 內建 review,不重複。
參考
| 檔案 | 用途 |
|---|---|
references/smells.md |
六組壞味道完整清單:定義、偵測訊號、建議重構手法、嚴重度分級;範例資料必須去識別化 |
references/comment-scope.md |
程式碼註解內容界線:禁止寫進註解的文件編號清單、允許項目與白名單、命中時的改法 |
相關 domain
jsc-sdlc:實作階段完成後呼叫本審查