为什么JSDoc同时允许Array <string>和Array。<string>,并且比另一个更好?

时间:2017-12-14 22:05:19

标签: javascript jsdoc

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

1 个答案:

答案 0 :(得分:0)

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

  

类型应用程序不再需要包含句点。例如,您可以编写public class TicketsQueueTest { @Test public void testTixQueue() { TicketsQueue<SimpleEntry<String, String>> tixQueue = new TicketsQueue<SimpleEntry<String, String>>(); tixQueue.offer("foo", "bar"); Assert.assertFalse("It's empty!", tixQueue.isEmpty()); } } 而不是Array<number>。我们应该更新所有示例以使用更简化的语法。

截至记录Array.<number>个对象时,已经回答了SO:How to specify an array of objects as a parameter or return value in JSDoc?