Menu
TypeScript の公開 API や複雑な helper に TSDoc を書く、または既存コメントを TSDoc として改善するときに使う。@param、@returns、@remarks、@example、@defaultValue、@see などを効果的に使い、説明文だけで終わらせない。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Design and implementation guidelines for React SPA. Includes recommended tech stacks, design guidelines, implementation guidelines, and warnings about bad practices and best practices. Always read when implementing frontend solutions using React.
rules for git commit message and PR title
| name | effective-tsdoc |
| description | TypeScript の公開 API や複雑な helper に TSDoc を書く、または既存コメントを TSDoc として改善するときに使う。@param、@returns、@remarks、@example、@defaultValue、@see などを効果的に使い、説明文だけで終わらせない。 |
TSDoc は「何となく説明するコメント」ではなく、API 契約を読むための構造化ドキュメントとして書く。
@param と @returns を省略しない@remarks に分ける@example を置く@defaultValue を置く@see {@link ...} でつなぐ@remarks：スコープ規則、制約、内部設計、限界を書く@param：型から読めない意味、前提、単位、同一性条件を書く@returns：正常時の値だけでなく、undefined や空配列を返す条件を書く@example：コンパクトに、実際の呼び出し形が分かるコードを書く@param value 値 のように型名や変数名を反復するだけの説明