[英]How to specify an array of objects as a parameter or return value in JSDoc?
[英]Document collection (array of type) return value and parameter in JSDoc
当数组元素可以是以下任何一个时,如何在JSDoc中记录Array
返回值(和参数):
String
, Array
)。 如果您正在寻找如何记录数组中对象的类型,您需要这样的东西:
/**
* @param {String[]} aliases
*/
http://code.google.com/p/jsdoc-toolkit/wiki/TagParam#Parameter_Type_Information
给出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
声明中使用它,其中第二种方法不起作用。
集合定义方法的缺点是它不允许描述属性值。
虽然您可能会发现某些其他答案中给出的指导对您有用,但我更喜欢这种语法:
/**
* @return {Array<String>} ...
*/
与其他人提供的指导相比,我认为这更符合您在问题中给出的示例的期望。
以下是有关JSDoc的最佳信息来源: https ://wiki.servoy.com/display/public/DOCS/JSDoc+Annotations
在http://usejsdoc.org/上的JSDoc文档中,给出了一个具有MyClass
类型成员的数组的示例。 有两种可能性。 一个看起来像这样:
@param{MyClass[]}
另一个是这样的:
@param{Array.<MyClass>}
注意这个.
在Array
和<
之间。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.