当数组元素可以是以下任何一个时,如何在JSDoc中记录Array
返回值(和参数):
String
,Array
)。答案 0 :(得分:29)
如果您正在寻找如何记录数组中对象类型的方法,您需要这样的内容:
/**
* @param {String[]} aliases
*/
http://code.google.com/p/jsdoc-toolkit/wiki/TagParam#Parameter_Type_Information
答案 1 :(得分:13)
给出screenings
参数:
screenings = [
{
timestamp: 1440157537,
url: 'https://stackoverflow.com/a/22787287/1269037',
},
{
timestamp: ...,
url: ...,
},
];
您可以通过以下三种方式之一记录:
@typedef
:/**
* @typedef {Object} screening
* @property {Number} timestamp - UNIX timestamp.
* @property {String} url - Booking URL.
*/
/**
* @param {screening[]}
*/
function positionTimes (screenings) {}
当有多个函数使用screening
对象的变体时,您可以使用函数名称空间,例如
/**
* @typedef {Object} positionTimes~screening
* @property {Number} timestamp - UNIX timestamp.
* @property {String} url - Booking URL.
*/
/**
* @param {positionTimes~screening[]}
*/
function positionTimes (screenings) {}
/**
* @typedef {Object} filterTimes~screening
* @property {Number} timestamp - UNIX timestamp.
* @property {String} url - Booking URL.
*/
/**
* @param {filterTimes~screening[]}
*/
function filterTimes (screenings) {}
/**
* @param {Object[]} screenings
* @param {Number} screenings[].timestamp - Unix timestamp.
* @param {String} screenings[].url - Booking URL.
*/
function positionTimes (screenings) {}
这对于描述@return
ed类型不起作用,因为返回值没有名称。
/**
* @param {Array.<{timestamp: Number, url: String}>} screenings
*/
function positionTimes (screenings) {}
这种方法的一个优点是它是单行的,所以你可以在@return
声明中使用它,第二种方法不会起作用。
集合定义方法的缺点是它不允许描述属性值。
答案 2 :(得分:6)
虽然您可能会发现某些其他答案中给出的指导对您有用,但我更喜欢这种语法:
/**
* @return {Array<String>} ...
*/
与其他人提供的指导相比,我认为根据您在问题中提供的示例,这更接近您的期望。
以下是有关JSDoc的最佳信息来源: https://wiki.servoy.com/display/public/DOCS/JSDoc+Annotations
答案 3 :(得分:3)
根据doco @returns
/**
* @returns {Array} Lines from the file.
*/
function readLines(filepath) {
}
答案 4 :(得分:0)
http://usejsdoc.org/ 上的 JSDoc 文档中,给出了一个类型为MyClass
成员的数组的示例。有两种可能性。一个看起来像这样:
@param{MyClass[]}
另一个是这样的:
@param{Array.<MyClass>}
请注意.
和Array
之间的<
。