tsdoc-comments
✓在记录公共 API 时使用。编写库代码时使用。使用 JSDoc 风格的注释时使用。生成文档时使用。在解释复杂类型时使用。
SKILL.md
TSDoc is the standard for documenting TypeScript code. It extends JSDoc with TypeScript-specific features like generic type parameters (@template). Good documentation explains not just what code does, but why, and helps users understand your API through IDE tooltips and generated docs.
Well-documented code reduces support burden and improves developer experience for your API consumers.
Document public APIs with TSDoc. Explain what, why, and provide examples. Use @template for generic type parameters.
在记录公共 API 时使用。编写库代码时使用。使用 JSDoc 风格的注释时使用。生成文档时使用。在解释复杂类型时使用。 来源:marius-townhouse/effective-typescript-skills。
可引用信息
为搜索与 AI 引用准备的稳定字段与命令。
- 安装命令
npx skills add https://github.com/marius-townhouse/effective-typescript-skills --skill tsdoc-comments- 分类
- </>开发工具
- 认证
- ✓
- 收录时间
- 2026-02-05
- 更新时间
- 2026-02-18
快速解答
什么是 tsdoc-comments?
在记录公共 API 时使用。编写库代码时使用。使用 JSDoc 风格的注释时使用。生成文档时使用。在解释复杂类型时使用。 来源:marius-townhouse/effective-typescript-skills。
如何安装 tsdoc-comments?
打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/marius-townhouse/effective-typescript-skills --skill tsdoc-comments 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用
这个 Skill 的源码在哪?
https://github.com/marius-townhouse/effective-typescript-skills