如何在jsdoc中描述"object“参数？
如何在jsdoc中描述"object“参数？
提问于 2011-06-24 05:06:56
// 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)
}回答 3
Stack Overflow用户
发布于 2013-03-01 19:06:46
有关使用{{field1: Number, field2: String}}的@return标签，请参阅：http://wiki.servoy.com/display/public/DOCS/Annotating+JavaScript+using+JSDoc
Stack Overflow用户
发布于 2020-03-05 10:54:03
如果希望参数具有特定的属性，则可以通过提供附加的@param标记来记录该属性。例如，如果employee参数需要具有name和department属性，则可以按如下方式记录该参数：
/**
* 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
Stack Overflow用户
发布于 2013-08-23 01:02:32
对于这些情况，有一个新的@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
*/页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/6460604
复制相关文章
相似问题