javascript - 如何判断我的方法接受 yuidoc 中的 {id: String, label: String} 数组？

Question

我无法在文档中找到它。

我更喜欢[{id: String, label: String}]在生成的文档中显示类型，并且实验让我认为我唯一能做的就是指定一个没有任何其他字符的纯字母数字字符串（它们被生成器忽略）。

真的没有办法吗？

Answer 1

只需创建一个 @class 指定该信息（两个属性 id 和标签）并使用该类！

Answer 2

有两种解决方案：

1）创建一个实际的命名类，并使用@class和@param标签来记录它。因为您的文字对象{id: String, label: String}基本上是一个内联/匿名类。所以让它匿名，实际上给它一个名字。然后您可以指定您的参数是该类的数组。像这样：

/**
 * @class MyLabel
 * @constructor
 * @param id {String}
 * @param label {String}
 */
function MyLabel(id, label) {
  this.id = id;
  this.label = label;
}

/* ... and then document your method, with the array of those objects, using: */

/**
 * @method myMethod
 * @param labels {MyLabel[]} Array of labels.
 */

这就是选项 1，并且需要对您的代码进行一些重构。但是，不要害怕命名、定义和记录你的类，只有好的东西才能产生。

2）另一种选择是您可以从 JSDocs 获取页面，并使用伪参数语法：

/**
 * @method myMethod
 * @param labels {Object[]} An array of label objects
 * @param labels[].id {String} Id
 * @param labels[].label {String} Label  
 */

我很确定这也会在 YUIdoc 中正确呈现。