SuperAPI AI 工具集

tsdoc

编程与开发

查看项目

更新于 10-15 21:41

技能介绍

用途:为 TypeScript 项目提供统一的 TSDoc 注释规范,确保注释可被 TypeDoc 解析,并明确哪些导出需要注释。

主要能力:规定必须使用 /** ... */ 形式;只允许 TypeDoc 支持的标签,禁止自定义标签;说明文用日语书写。可用块标签包括 @param、@typeParam、@returns、@throws、@remarks、@example、@see、@deprecated、@defaultValue、@category、@since;修饰标签 @internal;行内标签 {@link}、{@linkcode}、{@linkplain}。

必要用法:@param 用连字符分隔说明且不写类型,如 @param name - 说明;首行为一句话概要,详细内容空行后用 @remarks;Props interface 的每个属性直接写 TSDoc,而非用 @param;export default 组件在组件定义前写注释,named export 在各导出前写。@example 中的代码必须用 ```tsx 围栏。@defaultValue 直接写值,不加反引号。@category 使用统一名称:UI、Layout、Icon、Model、Data、Hooks、Utils、Config。

适用场景:共享组件、共享类型、共享常量、工具函数、自定义 Hook 为必须注释;features/widgets 组件推荐;pages 组件与文件内私有辅助函数可选。资料还提供 React 组件(tailwind-variants、Radix UI)、类型定义、常量、工具函数、自定义 Hook 的模板,以及 tags/、samples/、scripts/ 目录的查阅方式。

限制:资料未提供安装命令、lint 命令与 tsdoc.json 配置的具体内容,仅说明可查阅 scripts/README.md 等页面;未说明收费、平台或效果信息。