documentation
為 TypeScript 程式碼產生文件
또한 다음에서 사용할 수 있습니다: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,BfdCampos
撰寫文件會佔用 coding 的時間。此技能提供 TSDoc 註解、Storybook 故事、VitePress 指南和 TypeDoc API 參考文件的專業範本，讓您可以更快地完成文件撰寫。
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"documentation" 사용 중입니다. 為這個擷取使用者資料的函式建立文件
예상 결과:
- 簡短描述函式的功能
- @param userId - 使用者的唯一識別碼
- @returns Promise 解析為使用者資料物件
- @example const user = fetchUserById('123');
"documentation" 사용 중입니다. 為 Button 組件建立 Storybook 故事
예상 결과:
- 標題為 'Components/Button' 的 Meta 設定
- 無 args 的 default story
- isLoading: true 屬性的 loading variant
- isDisabled: true 屬性的 disabled variant
보안 감사
안전Pure documentation template skill with no executable code. All 53 static findings are false positives: SHA-256 hashes were misidentified as weak crypto, markdown code fences were misidentified as shell execution, and metadata fields were misidentified as security risks. The skill only contains documentation templates for TSDoc, Storybook, VitePress, and TypeDoc.
위험 요인
⚡ 스크립트 포함
🌐 네트워크 접근
📁 파일 시스템 액세스
🔑 환경 변수
⚙️ 외부 명령어
품질 점수
만들 수 있는 것
為匯出的函式建立文件
為函式新增包含參數、回傳類型和範例的 TSDoc 註解
建立組件故事
為 React 組件撰寫包含 args 和 variants 的 Storybook 故事
建構 API 參考文件
從 TSDoc 註解產生 TypeDoc API 文件
이 프롬프트를 사용해 보세요
為此函式新增 TSDoc 註解，包含 @param、@returns 和 @example 標籤。
為此 React 組件建立 Storybook 故事，包含 default、loading 和 error 狀態。
為此自訂鉤子新增 TSDoc 文件，包含選項、回傳值和使用範例。
產生 TypeDoc API 文件並更新此組件的 VitePress 側邊欄。
모범 사례
- 包含带有可執行程式碼片段的 @example 標籤
- 為所有匯出的函式和類型建立文件
- 在整個程式碼庫中使用一致的 TSDoc 格式
- 新增 TSDoc 註解後執行 'pnpm docs:api'
피하기
- 為複雜函式省略 @param 或 @returns 標籤
- 撰寫沒有上下文的模糊描述
- 當組件屬性變更時忘記更新 Storybook
- 不執行 TypeDoc 來重新產生 API 文件