问题标签 [yuidoc]

应该如何在 YUIdoc 中记录只读计算属性（例如 Ember.js 模型）？

假设我有一个简单的模型：

应该fullName标记为什么？

是@property吗？如果是这样，是否应该将其标记为@readOnly？我可以从两个方面看到它——因为它没有 setter 函数，所以它是一个只读属性。另一方面，它派生自可编辑/可设置的属性，因此它可以作为用户操作的结果而改变。

或者它是一个@method？因为它不仅使用其他属性，而且实际上转换它们？在这样一个简单的示例中，转换部分并不那么明显，但是说计算属性类似于nameInitials，它只返回名字和姓氏的第一个字母等？

另外：将@property标签用于 Ember 属性而不是@attribute标签是否正确？

如何正确记录返回多个参数的返回回调。可执行程序：

return callback(error, success);

根据 YUIdoc 的文档（在这种情况下似乎等同于 jsdoc），有一个 @throws 标记来记录可能引发的错误。

指定方法抛出的错误。@throws 标签具有结构 @throws {type} 描述。{type} 是可选的。

在我的例子中，函数中有几个检查可能会引发错误，所以我想用@throws 列出它们。但是你不能有多个@throws 标签。那么如何在这个标签中放置一个可能抛出的错误列表呢？

这里我以一个 emberJS 控制器为例。如何正确注释它以使用 YUIDoc 生成文档？

我有兴趣了解 emberJS 代码文档的最佳实践，所以最后我可以获得具有完整层次结构的适当文档。任何帮助将不胜感激。