如何描述“对象” jsdoc中的参数？ [英] How to describe "object" arguments in jsdoc?

问题描述

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

但是如何描述参数对象应该如何构造？例如，它应该是这样的：

But how do I describe how the parameters object should be structured? For example it should be something like:

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

推荐答案

从 @param wiki页面：

如果参数预期为有一个特定的属性，你可以在该参数的@param标签之后立即记录，如下所示：

If a parameter is expected to have a particular property, you can document that immediately after the @param tag for that parameter, like so:

 /**
  * @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);
 }

---

曾经有一个@config标签紧跟相应的@param，但它似乎已被弃用（这里的例子）。

这篇关于如何描述“对象” jsdoc中的参数？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！