用途:为 Medusa 代码库的 TypeScript 源文件添加 TypeDoc(TSDoc)注释,遵循 TypeDoc 约定及 www/utils/packages/typedoc-config/tsdoc.json 中定义的自定义标签。
主要能力:按文件类型提供对应文档深度,如 HTTP 类型记录每个导出接口及全部属性、API 路由仅记录导出处理器、UI 组件记录组件与全部 props、数据模型记录模型与每个属性、服务接口/JS SDK/Provider/工作流 SDK 完整记录每个方法,工作流与步骤记录导出及输入类型,事件记录每个事件常量。
必要用法:写 TSDoc 前按路径加载对应参考文件,例如 packages/core/types/src/http/ 用 reference/http-types.md,packages/medusa/src/api/admin/ 或 /store/ 用 reference/api-routes.md,packages/design-system/ui/src/components/ 用 reference/ui-components.md,packages/modules/*/src/models/ 用 reference/data-models.md,packages/core/js-sdk/src/ 等用 reference/service-interfaces.md,packages/core/core-flows/src/ 用 reference/workflows-steps.md,packages/core/utils/src/core-flows/events.ts 用 reference/events.md。使用 /** */ 块格式。
限制:绝不记录未导出的条目;绝不给测试文件添加 TSDoc(跳过 .spec.ts、.test.ts、tests/);绝不编造 @since 版本号,仅用提示中给定的版本;绝不删除或修改已有 TSDoc;不修改逻辑,仅增改注释块。自定义标签仅限 tsdoc.json 中定义的:@expandable、@featureFlag、@since、@apiIgnore、@schema、@tags、@version、@keep、@customNamespace、@namespaceMember,另可用标准 TypeDoc/JSDoc 标签。