分割代入パラメータのJSDoc
オブジェクトや配列の分割代入パラメータを持つ関数のJSDocを生成します。@paramタグのドット表記を使用してネストされたプロパティをドキュメント化します。
Advanced Patterns
詳細な説明
分割代入パラメータのドキュメント化
分割代入パラメータはモダンJavaScriptとTypeScriptで一般的です。JSDocのアプローチでは、分割代入されたオブジェクトの各プロパティをドット表記でドキュメント化します。
シグネチャの例
function createUser({
name,
email,
role = "viewer",
preferences: { theme = "dark", language = "en" },
}: CreateUserInput): User
ドット表記のルール
JSDocはネストされたプロパティにドット表記を使用します：
| パターン | 意味 |
|---|---|
@param options |
トップレベルのパラメータ |
@param options.name |
optionsのプロパティ |
@param options.prefs.theme |
ネストされたプロパティ |
@param [options.role] |
オプションのプロパティ |
@param [options.role="viewer"] |
デフォルト値付きオプション |
TSDocの代替
TSDocでは、オブジェクト全体に@paramを使用し、インターフェース型にリンクできます：
/**
* @param options - プロパティの詳細は{@link CreateUserInput}を参照。
*/
ユースケース
React コンポーネントのprops（別のインターフェースを使用しない場合）、設定ファクトリ関数、APIハンドラーオプション、分割代入によるnamed parameterパターンを使用する関数のドキュメント化。