jsdoc-tag-order
JSDoc タグの順序を統一します。
- ルール ID:
tai-kun/jsdoc-tag-order - 自動修正: なし
JSDoc のタグを @template/@typeParam → @param → @default → @returns → @throws → @note → @deprecated → @internal/@beta → @see → 未知タグの順に並べます。
設定
このルールを有効にするには、vite.config.ts の lint.rules に追加します。
"tai-kun/jsdoc-tag-order": "error",例
違反例
/**
* @returns 結果
* @param value 値
*/修正後
/**
* @param value 値
*
* @returns 結果
*/注意
- 報告のみで、自動修正は行いません。
@exampleやコードフェンスを含むコメントは対象外です。- 未知のタグは既知のタグより後ろに置きます。