如何在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)
}

从@param 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);
 }

曾经有一个@config标记，紧跟在相应的@param之后，但是它似乎已被弃用（此处为示例）。

到目前为止，有4种不同的方式将对象记录为参数/类型。每个都有自己的用途。但是，其中只有3个可用于记录返回值。

对于具有一组已知属性的对象（变量A）

/**
 * @param {{a: number, b: string, c}} myObj description
 */

对于仅用作此函数参数且不需要进一步描述每个属性的对象，此语法是理想的。它可用于@returns和。

对于具有一组已知属性的对象（变体B）

具有属性语法的参数非常有用：

/**
 * @param {Object} myObj description
 * @param {number} myObj.a description
 * @param {string} myObj.b description
 * @param {} myObj.c description
 */

对于仅用作该函数参数且需要进一步描述每个属性的对象，此语法非常理想。不能用于@returns。

对于将在源中多个点使用的对象

在这种情况下，@typedef非常方便。你可以在你的代码的一个点定义的类型和使用它作为一个类型@param或@returns或其他JSDoc标签，可以让使用的类型。

/**
 * @typedef {Object} Person
 * @property {string} name how the person is called
 * @property {number} age how many years the person lived
 */

然后，您可以在@param标签中使用它：

/**
 * @param {Person} p - Description of p
 */

或在@returns：

/**
 * @returns {Person} Description
 */

对于其值均相同类型的对象

/**
 * @param {Object.<string, number>} dict
 */

第一种类型（字符串）记录了键的类型，这些键的类型在JavaScript中始终为字符串，或者至少始终会强制为字符串。第二种类型（数字）是值的类型；这可以是任何类型。此语法也可以用于@returns。

资源资源

有关文档类型的有用信息，可以在这里找到：

https://jsdoc.app/tags-type.html

PS：

要记录可选值，可以使用[]：

/**
 * @param {number} [opt_number] this number is optional
 */

要么：

/**
 * @param {number|undefined} opt_number this number is optional
 */

我看到有关@return标记的答案已经存在，但是我想提供更多有关它的详细信息。

首先，官方JSDoc 3文档没有提供有关自定义对象@return的任何示例。请参阅https://jsdoc.app/tags-returns.html。现在，让我们看看在出现一些标准之前我们可以做什么。

• 函数返回动态生成键的对象。范例：{1: 'Pete', 2: 'Mary', 3: 'John'}。通常，我们在的帮助下对该对象进行迭代for(var key in obj){...}。

  根据https://google.github.io/styleguide/javascriptguide.xml#JsTypes可能的JSDoc

  /**
   * @return {Object.<number, string>}
   */
  function getTmpObject() {
      var result = {}
      for (var i = 10; i >= 0; i--) {
          result[i * 3] = 'someValue' + i;
      }
      return result
  }

• 函数返回键为已知常量的对象。范例：{id: 1, title: 'Hello world', type: 'LEARN', children: {...}}。我们可以轻松访问此对象的属性：object.id。

  根据https://groups.google.com/forum/#!topic/jsdoc-users/TMvUedK9tC4可能的JSDoc

  • 假装。

    /**
     * Generate a point.
     *
     * @returns {Object} point - The point generated by the factory.
     * @returns {number} point.x - The x coordinate.
     * @returns {number} point.y - The y coordinate.
     */
    var pointFactory = function (x, y) {
        return {
            x:x,
            y:y
        }
    }

  • 光猪六壮士。

    /**
     @class generatedPoint
     @private
     @type {Object}
     @property {number} x The x coordinate.
     @property {number} y The y coordinate.
     */
    function generatedPoint(x, y) {
        return {
            x:x,
            y:y
        };
    }
    
    /**
     * Generate a point.
     *
     * @returns {generatedPoint} The point generated by the factory.
     */
    
    var pointFactory = function (x, y) {
        return new generatedPoint(x, y);
    }

  • 定义类型。

    /**
     @typedef generatedPoint
     @type {Object}
     @property {number} x The x coordinate.
     @property {number} y The y coordinate.
     */
    
    
    /**
     * Generate a point.
     *
     * @returns {generatedPoint} The point generated by the factory.
     */
    
    var pointFactory = function (x, y) {
        return {
            x:x,
            y:y
        }
    }

  根据https://google.github.io/styleguide/javascriptguide.xml#JsTypes

  • 记录类型。

    /**
     * @return {{myNum: number, myObject}}
     * An anonymous type with the given type members.
     */
    function getTmpObject() {
        return {
            myNum: 2,
            myObject: 0 || undefined || {}
        }
    }

有关@return标记的使用{{field1: Number, field2: String}}，请参见：http : //wiki.servoy.com/display/public/DOCS/Annotating+JavaScript+using+JSDoc

如果期望参数具有特定属性，则可以通过提供其他@param标记来记录该属性。例如，如果期望员工参数具有名称和部门属性，则可以将其记录如下：

/**
 * Assign the project to a list of employees.
 * @param {Object[]} employees - The employees who are responsible for the project.
 * @param {string} employees[].name - The name of an employee.
 * @param {string} employees[].department - The employee's department.
 */
function(employees) {
    // ...
}

如果在没有显式名称的情况下对参数进行了分解，则可以为对象指定一个适当的参数并记录其属性。

/**
 * Assign the project to an employee.
 * @param {Object} employee - The employee who is responsible for the project.
 * @param {string} employee.name - The name of the employee.
 * @param {string} employee.department - The employee's department.
 */
Project.prototype.assign = function({ name, department }) {
    // ...
};

资料来源：JSDoc

@config这些情况有一个新标签。它们链接到前一个@param。

/** My function does X and Y.
    @params {object} parameters An object containing the parameters
    @config {integer} setting1 A required setting.
    @config {string} [setting2] An optional setting.
    @params {MyClass~FuncCallback} callback The callback function
*/
function(parameters, callback) {
    // ...
};

/**
 * This callback is displayed as part of the MyClass class.
 * @callback MyClass~FuncCallback
 * @param {number} responseCode
 * @param {string} responseMessage
 */