feat: adding JSDoc
This commit is contained in:
@@ -113,6 +113,14 @@ packages/result # output
|
||||
- 不要讓 agent 修改 `prototype/`、`frontend/`、`backend/` 原始輸入資料夾;生成與執行 artifact 應限制在 `output/` 與 `.ht/`。
|
||||
- 保持 MVP 邊界,避免加泛用抽象或一開始支援所有 monorepo 形態。
|
||||
|
||||
## JSDoc 原則
|
||||
|
||||
- 依專案的 `jsdoc` skill 撰寫 JSDoc;這裡只補充 HTML Transform 專案特有規則。
|
||||
- JavaScript 的 JSDoc 優先補在 exported API、stage 入口、跨模組 helper,或描述非顯而易見契約與限制的位置;不為測試檔或區域性小函式刻意補註解。
|
||||
- JSDoc 使用繁體中文,並把說明重點放在 artifact、pipeline stage、MVP 限制、cache/placeholder 行為、輸入輸出契約等專案脈絡。
|
||||
- 不新增 `jsdoc` 產生 HTML 文件的設定、script 或 build step,除非使用者明確要求。
|
||||
- 補 JSDoc 不應順手 refactor、改行為、加抽象或擴大 scope。
|
||||
|
||||
## 驗證
|
||||
|
||||
完成任何改動後至少執行:
|
||||
|
||||
Reference in New Issue
Block a user