1. ホーム
  2. javascript

[解決済み] jsdocで "object "引数を記述するには?

2022-03-24 14:52:49

質問

// My function does X and Y.
// @params {object} parameters An object containing the parameters
// @params {function} callback The callback function
function(parameters, callback) {
}

しかし、パラメータオブジェクトの構造をどのように記述すればよいのでしょうか?たとえば、次のようなものです。

{
  setting1 : 123, // (required, integer)
  setting2 : 'asdf' // (optional, string)
}

解決方法は?

からの 引数付きWikiページ :


プロパティを持つパラメータ

パラメータが特定のプロパティを持つことが期待される場合、そのパラメータの@paramタグの直後に、以下のようにそのプロパティを記述することができます。

 /**
  * @param userInfo Information about the user.
  * @param userInfo.name The name of the user.
  * @param userInfo.email The email of the user.
  */
 function logIn(userInfo) {
        doLogIn(userInfo.name, userInfo.email);
 }


以前は、対応する @param の直後に続く @config タグがありましたが、非推奨になったようです ( この例 ).