【问题标题】:Why does JSDoc allow both Array<string> and Array.<string>, and is one better than the other?为什么 JSDoc 允许同时使用 Array<string> 和 Array.<string>,并且一个比另一个好?
【发布时间】:2017-12-16 04:03:24
【问题描述】:

JSDoc 似乎有 2 种不同但相似的语法 参数化类型。第一种语法的示例 是Array.&lt;MyClass&gt;(你可以找到here)。第二个例子是Array&lt;number&gt; (你可以找到here)。 为什么两种语法都支持,而且一种比另一种更好?

【问题讨论】:

  • 你为什么期望一个比另一个更好?
  • @Li357:我猜一种语法比另一种新,并且被引入是因为它被认为更好。

标签: javascript jsdoc


【解决方案1】:

没有“更好”或“有价值”的方式来记录您的代码。您看到的是 JSDoc 文档中的不一致。他们有积压项目以使其保持一致:Clean up examples of type applications,其内容如下:

类型应用程序不再需要包含句点。例如,您可以写Array&lt;number&gt; 而不是Array.&lt;number&gt;。我们应该更新所有示例以使用更精简的语法。

在记录Arrays 的对象时,已经有答案:How to specify an array of objects as a parameter or return value in JSDoc?

【讨论】:

  • 您引用的文字清楚地表明最好省略点。这在this GitHub comment 中更加清晰,它表示“Promise&lt;number&gt;Promise.&lt;number&gt; 更可取”。无论如何,你已经引导我回答了我的问题,所以谢谢你。
  • @StarFlow 很高兴它帮助了你。接受答案:How does it work?
猜你喜欢
  • 2016-01-16
  • 1970-01-01
  • 2019-03-05
  • 2016-11-09
  • 2019-07-15
  • 2018-08-16
  • 1970-01-01
  • 1970-01-01
  • 2019-11-23
相关资源
最近更新 更多