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日 23:14