工程開發
writeJsDoc avatar

writeJsDoc

自動化維護 DuploJS 工具庫的 JSDoc 文檔,確保 index.md 結構的一致性並同步代碼範例。

簡介

writeJsDoc 技能是專門為 DuploJS 生態系統設計的工具,用於標準化 utils 儲存庫內的文檔維護。它簡化了位於 jsDoc/{namespace}/{function}/ 目錄下 JSDoc 檔案的生命週期,強制執行內容與程式碼範例的嚴格結構。此工具確保每個工具函數都有清晰、易於發現的文檔路徑,協助開發者在沒有手動格式化負擔的情況下維護高品質的 API 參考。

  • 自動管理 index.md 結構,強制執行特定順序:函數說明、調用模式(經典/柯里化)、行為細節、互動式範例、備註以及必要的 @see 文檔連結。

  • 協調 example.ts 檔案的建立,確保每個函數至少具備三個教學範例,並透過 {@include} 標籤實現程式碼重用,保持文檔與原始程式碼同步。

  • 針對複雜重載場景(如斷言模式)提供明確處理,強制要求同時提供經典 'if' 語句與 'pipe + when' 柯里化組合的範例。

  • 根據專案配置 (scripts/index.ts) 驗證 @namespace 指派,確保歸類正確(例如 Array 為 A,DataParser 為 DP)。

  • 利用預定義的 index.md 與 example.ts 模板確保整個函式庫的一致性,遵循專案的 '卓越開發體驗 (good DX)' 與函數式編程理念。

  • 此工具要求開發者在 jsDoc 目錄中維護文檔,並利用 {@include} 標籤的行數範圍功能從 example.ts 檔案中提取特定程式碼片段。

  • 使用者必須確保 example.ts 保持簡潔專注,避免冗餘,並遵循 DuploJS utils 儲存庫標準的 @scripts 導入模式。

  • 在記錄斷言 (predicate) 時,此技能要求為標準檢查與函數管道整合提供不同的使用範例。

  • 定期執行此技能可確保生成的文檔符合最新的 API 變更,並透過 @see 標籤提供正確的英文線上文檔連結。

倉庫統計

Star 數
13
Fork 數
0
Open Issue 數
0
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午11:14
在 GitHub 查看