代码之家 › 专栏 › 技术社区 › Pulasthi Bandara

如何使用JsDoc记录解构参数

jsdoc ecmascript-6 javascript

Pulasthi Bandara · 技术社区 · 7 年前

如何记录在函数参数中解构的函数参数?

/**
 * Function deconstructs argument and do stuff.
 * @param {} *** what should i do here? ***
 */
function someFunction({ key1, key2, key3 }) {
    // do function stuffs
}

1 回复 | 直到 7 年前

Felix Kling 7 年前

从 @param wiki page :

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

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

推荐文章

CryptoBird · 此文档是否正确?(是/否回答对我来说就足够了)

6 年前

Mike · 在JavaScript文件中使用类型化定义的vscode

7 年前

FabianTe · JSDoc:条件忽略是否可能?

7 年前

Everton Lenger · 带有jQuery参数的PhpStorm警告

7 年前

newBee · JSDoc@param-从另一个模块引用类

7 年前

Chacha · 不同文件中定义的对象的JSdoc

7 年前

a-h · jsdoc和vscode:记录作为参数传递给另一个函数的函数

7 年前

hkk David Calhoun · Tern无法使用JSDoc类型信息

7 年前

Pulasthi Bandara · 如何使用JsDoc记录解构参数

7 年前

Tom · 如何在WebStorm中的hover上启用intellisense/JSDoc信息?

7 年前