blocks|key|247874|text|根据doco+@returns|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|247875|/**+
+*+@returns+{Array}+Lines+from+the+file.
+*/
function+readLines(filepath)+{
}|code-block|syntax|javascript|247876|Also+see。|247877|entityMap|0|LINK|mutability|MUTABLE|url|http://code.google.com/p/jsdoc-toolkit/wiki/TagReturns|1|http://google.com/codesearch#search/&q=%255E.%252a@returns%2520%257B.%252aarray%2520lang%253a%255Ejavascript%2524&type=cs^0|7|8|7|8|0|0|0|0|8|1|0^^$0|@$1|2|3|4|5|6|7|W|8|@$9|X|A|Y|B|C]]|D|@$9|Z|A|10|1|11]]|E|$]]|$1|F|3|G|5|H|7|12|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|13|8|@]|D|@$9|14|A|15|1|16]]|E|$]]|$1|M|3|-4|5|6|7|17|8|@]|D|@]|E|$]]]|N|$O|$5|P|Q|R|E|$S|T]]|U|$5|P|Q|R|E|$S|V]]]]

As per doco <a href="http://code.google.com/p/jsdoc-toolkit/wiki/TagReturns" rel="nofollow"><code>@returns</code></a>

<pre><code>/** 
 * @returns {Array} Lines from the file.
 */
function readLines(filepath) {
}
</code></pre>

<a href="http://google.com/codesearch#search/&amp;q=%5E.%2a@returns%20%7B.%2aarray%20lang%3a%5Ejavascript%24&amp;type=cs" rel="nofollow">Also see</a>.

blocks|key|243045|text|如果您正在寻找如何在数组中记录对象的类型，则需要如下所示：|type|unstyled|depth|inlineStyleRanges|offset|length|style|BOLD|entityRanges|data|243046|/**
+*+@param+{String[]}+aliases
+*/|code-block|syntax|javascript|243047|在花括号内，String[]是参数类型:键入String作为数组[]。|CODE|243048|另请参阅jsdoc-toolkit，关于@Param+tag,+Parameter+Type+Information的归档维基页面|243049|243050|参数类型信息|blockquote|243051|243052|使用花括号将参数的预期类型括起来，以记录此信息。|243053|/**+*+@param+{String}+userName+*/+function+logIn(userName)+{+//+...+}|243054|使用管道符号来记录允许多种类型。|243055|/**+*+@param+{String%7CNumber}+product+*/|243056|在类型后面使用[]表示法来表示这些类型的数组。|243057|/**+*+@param+{String[]}+aliases+*/|243058|entityMap|0|LINK|mutability|MUTABLE|url|https://code.google.com/archive/p/jsdoc-toolkit/wikis/TagParam.wiki#Parameter_Type_Information^0|A|2|I|2|0|0|6|8|M|6|W|2|0|K|12|0|0|0|0|0|0|0|1X|0|0|0|13|0|0|0|Y|0^^$0|@$1|2|3|4|5|6|7|1E|8|@$9|1F|A|1G|B|C]|$9|1H|A|1I|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|1J|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|1K|8|@$9|1L|A|1M|B|M]|$9|1N|A|1O|B|M]|$9|1P|A|1Q|B|M]]|D|@]|E|$]]|$1|N|3|O|5|6|7|1R|8|@]|D|@$9|1S|A|1T|1|1U]]|E|$]]|$1|P|3|-4|5|6|7|1V|8|@]|D|@]|E|$]]|$1|Q|3|R|5|S|7|1W|8|@]|D|@]|E|$]]|$1|T|3|-4|5|6|7|1X|8|@]|D|@]|E|$]]|$1|U|3|V|5|6|7|1Y|8|@]|D|@]|E|$]]|$1|W|3|X|5|6|7|1Z|8|@$9|20|A|21|B|M]]|D|@]|E|$]]|$1|Y|3|Z|5|6|7|22|8|@]|D|@]|E|$]]|$1|10|3|11|5|6|7|23|8|@$9|24|A|25|B|M]]|D|@]|E|$]]|$1|12|3|13|5|6|7|26|8|@]|D|@]|E|$]]|$1|14|3|15|5|6|7|27|8|@$9|28|A|29|B|M]]|D|@]|E|$]]|$1|16|3|-4|5|6|7|2A|8|@]|D|@]|E|$]]]|17|$18|$5|19|1A|1B|E|$1C|1D]]]]

If you're looking for how to document the type of objects in an array, you want something like this:
<pre class="lang-js prettyprint-override"><code>/**
 * @param {String[]} aliases
 */
</code></pre>
Here inside curly-braces the <code>String[]</code> is the parameter type: type <code>String</code> as array <code>[]</code>.
See also jsdoc-toolkit, archived wiki page about <a href="https://code.google.com/archive/p/jsdoc-toolkit/wikis/TagParam.wiki#Parameter_Type_Information" rel="nofollow noreferrer">@Param tag, Parameter Type Information</a>:
<blockquote>
Parameter Type Information
Use curly-braces around the expected type of the parameter to document this information.
<code>/** * @param {String} userName */ function logIn(userName) { // ... }</code>
Use a pipe symbol to document that multiple types are permitted.
<code>/** * @param {String|Number} product */</code>
Use the [] notation after a type to indicate an array of those types.
<code>/** * @param {String[]} aliases */</code>
</blockquote>

blocks|key|247949|text|尽管您可能会发现其他一些答案中给出的指导对您有效，但我更喜欢这个语法：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|247950|/**
+*+@return+{Array<String>}+...
+*/|code-block|syntax|javascript|247951|与其他人提供的指导相比，根据您在问题中给出的示例，我认为这更接近您的期望。|247952|这是关于JSDoc的很好的信息来源：https://wiki.servoy.com/display/DOCS/JSDoc%2BAnnotations|offset|length|247953|编辑:修复了移动的链接-感谢@hc_dev的注意|247954|entityMap|0|LINK|mutability|MUTABLE|url|https://wiki.servoy.com/display/DOCS/JSDoc%2BAnnotations^0|0|0|0|I|1I|0|0|0^^$0|@$1|2|3|4|5|6|7|W|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|X|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|Y|8|@]|9|@]|A|$]]|$1|I|3|J|5|6|7|Z|8|@]|9|@$K|10|L|11|1|12]]|A|$]]|$1|M|3|N|5|6|7|13|8|@]|9|@]|A|$]]|$1|O|3|-4|5|6|7|14|8|@]|9|@]|A|$]]]|P|$Q|$5|R|S|T|A|$U|V]]]]

Although you may find that the guidance given in some of the other answers works for you, I prefer this syntax:
<pre><code>/**
 * @return {Array&lt;String&gt;} ...
 */
</code></pre>
And in comparison to the guidance others have offered, I think this is closer to your expectation based on the example you give in your question.
Here's great source for information on JSDoc:
<a href="https://wiki.servoy.com/display/DOCS/JSDoc+Annotations" rel="nofollow noreferrer">https://wiki.servoy.com/display/DOCS/JSDoc+Annotations</a>
Edit: fixed moved link - thanks @hc_dev for noticing

blocks|key|2919923|text|给定一个screenings参数：|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|2919924|screenings+=+[
++++{
++++++++timestamp:+1440157537,
++++++++url:+'https://stackoverflow.com/a/22787287/1269037',
++++},
++++{
++++++++timestamp:+...,
++++++++url:+...,
++++},
];|code-block|syntax|javascript|2919925|您可以通过以下三种方式之一对其进行记录：|2919926|使用@typedef|2919927|/**
+*+@typedef+{Object}+screening
+*+@property+{Number}+timestamp+-+UNIX+timestamp.
+*+@property+{String}+url+-+Booking+URL.
+*/

/**
+*+@param+{screening[]}
+*/
function+positionTimes+(screenings)+{}|2919928|当有多个函数使用screening对象的变体时，可以使用函数名称空间，例如|2919929|/**
+*+@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)+{}|2919930|记录properties+of+the+values+in+an+array|2919931|/**
+*+@param+{Object[]}+screenings
+*+@param+{Number}+screenings[].timestamp+-+Unix+timestamp.
+*+@param+{String}+screenings[].url+-+Booking+URL.
+*/
function+positionTimes+(screenings)+{}|2919932|这不适用于描述@returned类型，因为返回值不带名称。|2919933|使用集合定义：|2919934|/**
+*+@param+{Array.<{timestamp:+Number,+url:+String}>}+screenings
+*/
function+positionTimes+(screenings)+{}|2919935|这种方法的一个优点是它是一行程序，所以您可以在@return声明中使用它，而第二种方法不起作用。|2919936|集合定义方法的缺点是它不允许描述属性值。|2919937|entityMap|0|LINK|mutability|MUTABLE|url|http://usejsdoc.org/tags-typedef.html|1|http://usejsdoc.org/tags-param.html#parameters-with-properties|2|http://usejsdoc.org/tags-returns.html^0|4|A|0|0|0|2|8|2|8|0|0|0|8|9|0|0|2|10|1|0|0|7|7|7|7|2|0|0|0|N|7|0|0^^$0|@$1|2|3|4|5|6|7|1K|8|@$9|1L|A|1M|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|1N|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|1O|8|@]|D|@]|E|$]]|$1|M|3|N|5|6|7|1P|8|@$9|1Q|A|1R|B|C]]|D|@$9|1S|A|1T|1|1U]]|E|$]]|$1|O|3|P|5|H|7|1V|8|@]|D|@]|E|$I|J]]|$1|Q|3|R|5|6|7|1W|8|@$9|1X|A|1Y|B|C]]|D|@]|E|$]]|$1|S|3|T|5|H|7|1Z|8|@]|D|@]|E|$I|J]]|$1|U|3|V|5|6|7|20|8|@]|D|@$9|21|A|22|1|23]]|E|$]]|$1|W|3|X|5|H|7|24|8|@]|D|@]|E|$I|J]]|$1|Y|3|Z|5|6|7|25|8|@$9|26|A|27|B|C]]|D|@$9|28|A|29|1|2A]]|E|$]]|$1|10|3|11|5|6|7|2B|8|@]|D|@]|E|$]]|$1|12|3|13|5|H|7|2C|8|@]|D|@]|E|$I|J]]|$1|14|3|15|5|6|7|2D|8|@$9|2E|A|2F|B|C]]|D|@]|E|$]]|$1|16|3|17|5|6|7|2G|8|@]|D|@]|E|$]]|$1|18|3|-4|5|6|7|2H|8|@]|D|@]|E|$]]]|19|$1A|$5|1B|1C|1D|E|$1E|1F]]|1G|$5|1B|1C|1D|E|$1E|1H]]|1I|$5|1B|1C|1D|E|$1E|1J]]]]

Given a <code>screenings</code> parameter:

<pre class="lang-js prettyprint-override"><code>screenings = [
 {
 timestamp: 1440157537,
 url: 'https://stackoverflow.com/a/22787287/1269037',
 },
 {
 timestamp: ...,
 url: ...,
 },
];
</code></pre>

You can document it one of the three ways:

<h2>Using <a href="http://usejsdoc.org/tags-typedef.html" rel="noreferrer"><code>@typedef</code></a>:</h2>

<pre class="lang-js prettyprint-override"><code>/**
 * @typedef {Object} screening
 * @property {Number} timestamp - UNIX timestamp.
 * @property {String} url - Booking URL.
 */

/**
 * @param {screening[]}
 */
function positionTimes (screenings) {}
</code></pre>

When there are multiple functions that use a variation of the <code>screening</code> object, you can use a function namespace, e.g.

<pre class="lang-js prettyprint-override"><code>/**
 * @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) {}
</code></pre>

<h2>Documenting the <a href="http://usejsdoc.org/tags-param.html#parameters-with-properties" rel="noreferrer">properties of the values in an array</a>:</h2>

<pre class="lang-js prettyprint-override"><code>/**
 * @param {Object[]} screenings
 * @param {Number} screenings[].timestamp - Unix timestamp.
 * @param {String} screenings[].url - Booking URL.
 */
function positionTimes (screenings) {}
</code></pre>

This won't work for describing <a href="http://usejsdoc.org/tags-returns.html" rel="noreferrer"><code>@return</code></a>ed types because the return value doesn't take a name.

<h2>Using a collection definition:</h2>

<pre class="lang-js prettyprint-override"><code>/**
 * @param {Array.&lt;{timestamp: Number, url: String}&gt;} screenings
 */
function positionTimes (screenings) {}
</code></pre>

An advantage of this approach is that it's a one-liner so you can use it in <code>@return</code> declarations, where the second method won't work.

The disadvantage of the collection definition approach is that it doesn't allow describing property values.

blocks|key|243195|text|在上的JSDoc文档中，给出了一个成员类型为MyClass的数组的示例。有两种可能性。其中一个看起来像这样：|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|243196|@param{MyClass[]}|code-block|syntax|javascript|243197|另一个是这样的：|243198|@param{Array.<MyClass>}|243199|注意Array和<之间的.。|243200|entityMap^0|M|7|0|0|0|0|2|5|8|1|C|1|0^^$0|@$1|2|3|4|5|6|7|S|8|@$9|T|A|U|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|V|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|W|8|@]|D|@]|E|$]]|$1|M|3|N|5|H|7|X|8|@]|D|@]|E|$I|J]]|$1|O|3|P|5|6|7|Y|8|@$9|Z|A|10|B|C]|$9|11|A|12|B|C]|$9|13|A|14|B|C]]|D|@]|E|$]]|$1|Q|3|-4|5|6|7|15|8|@]|D|@]|E|$]]]|R|$]]

In the documentation for JSDoc on <a href="http://usejsdoc.org/tags-type.html" rel="nofollow">http://usejsdoc.org/</a> there is an example given for an array with members of type <code>MyClass</code>. There are two possibilities. One looks like this:

<pre><code>@param{MyClass[]}
</code></pre>

The other one like this:

<pre><code>@param{Array.&lt;MyClass&gt;}
</code></pre>

Be aware of the <code>.</code> between <code>Array</code> and <code>&lt;</code>.

How to document <code>Array</code> return value (and parameters) in JSDoc when array elements can be either of the following:

<ul>
<li>A type (e.g. <code>String</code>, <code>Array</code>).</li>
<li>An object literal.</li>
</ul>

Document collection (array of type) return value and parameter in JSDoc

Unix

当数组元素可以是以下两种类型之一时，如何在JSDoc中记录Array返回值(和参数)：对象文字A类型(如String，Array).An 。

问文档集合(类型的数组)返回值和JSDoc中的参数
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问文档集合(类型的数组)返回值和JSDoc中的参数EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问文档集合(类型的数组)返回值和JSDoc中的参数
EN