·tsdoc-comments

在記錄公共 API 時使用。編寫庫代碼時使用。使用 JSDoc 風格的註釋時使用。生成文檔時使用。在解釋複雜類型時使用。

7安裝·0熱度·@marius-townhouse

安裝

$npx skills add https://github.com/marius-townhouse/effective-typescript-skills --skill tsdoc-comments

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