☰

jsdoc で「オブジェクト」引数を記述するにはどうすればいいですか? 質問する

tag-icon • tag-icon javascript jsdoc
jsdoc で「オブジェクト」引数を記述するにはどうすればいいですか? 質問する 
// 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)
}

ベストアンサー1

から@param ウィキページ:

プロパティ付きパラメータ

パラメータに特定のプロパティが期待される場合は、次のようにそのパラメータの @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タグがありましたが、非推奨になったようです（例はこちら）。

おすすめ記事