问题标签 [yuidoc]

我有一个Foo被传递的对象。

我的 foo 对象要大得多，我不想对我记录的每一个方法都重复这个。我也不想每次Foo结构发生变化都去更新 100 个方法。

有没有办法Foo单独声明对象结构（又是一种类型？），然后从@param标签中引用它。

是否可以忽略 yuidoc 中的各种标签以使文档构建过程消息更有用。

我对@author、@date 等标签有疑问

并且有大量文件使得无法找到“真正的”警告“有没有办法在 yuidoc 中排除标签？

我正在使用 YUIDOC 将 Javascript 注释转换为 chm 文件。

然后我已经安装了node.js，我已经运行了命令yuidoc，但是当我运行命令时yuidoc E:\foldername\filename.js没有错误出现，但警告出现路径参数丢失并且还显示选项。请告诉我如何成功地做到这一点。谢谢你

我有一个带有插件的 javascript 类。这些插件实际上添加/替换了这个类的功能。但是，我不知道应该如何记录这些插件。例如，如果我有一个类和插件如下

班级：

插入：

因此，该插件替换了“添加”功能并添加了新的“栏”功能。我遇到的问题是这个插件不是 Foo 的类或子类。它也不是模块或子模块（我认为）。有什么建议在这种情况下最好做吗？

在过去的 4 天里，我一直在试图让 yuidoc 解析我的 javascript 框架，这真的让我抓狂了。

这是我的 json 配置文件

它正在解析 json 配置并且没有错误。这是输出：

我可以使用命令行和输出和主题的默认设置让它工作，但它没有我的项目构建和版本信息。Bootstrap 主题在 Github 上并且确实有效。我在 Windows 7 64 位上使用 Cygwin 64 位。

我有... - 检查行尾 - 以最少的编辑复制和粘贴 yuidocs 示例 - 以各种方式尝试命令行 - 验证所有路径和目录都存在

帮助！为什么没有错误也没有输出。

我需要在我正在处理的 javascript 项目中添加一些自定义插件，例如 @date 和 @author。

我们将 yuidoc 用于文档目的。

但是这里有两种情况

1> yuidoc 中没有@data 标签

2> @author 标签存在但未显示在文档中

这是可用标签的列表

http://yui.github.io/yuidoc/syntax/

如何使这些标签显示在我的文档中？

有没有办法可以添加自定义标签以显示在 yuidoc 中？

我想我在 yuidoc 文档中遗漏了一些东西或误解了用法。我似乎找不到在我的文档中包含指向外部站点/页面的链接的方法。

在评论块中，我想要这样的东西：

我正在使用 YUIdoc。还要别的吗 ？谁能告诉我如何在 Ember 中正确记录模型、控制器、mixin 和视图？

例如，我试图记录这一点：

编辑我现在使用 YUIdoc 而不是 jsdoc3

如何使用 YUI Doc 定义全局变量。我找不到合适的注释标签来定义全局对象及其属性。最好的方法是什么。下面是我定义的对象：

YUIDocs 等文档工具允许您使用@class注释块中的标签来识别和描述类（对象类）。每个标识的类都需要一个@static或@constructor标记，定义如下：

• @constructor- 表示该类是可实例化的（使用 new 关键字创建）。
• @static- 表示您不应使用 new 实例化该类。您可以静态调用所有类的方法。

在 Ember 中，您经常使用extend(). 据我所知，这不会创建类的新实例。然而，许多这些定义（例如路由的控制器）是单例的，即使您使用extend()它们来定义它们。

因此，我的问题是：在 ember 应用程序中记录类的哪些常见情况下，您会使用@constructorvs@static吗？这样的例子是：

• 初始化器
• 路由器
• 适配器
• 序列化器
• 转型
• 路线
• 商店
• 楷模
• 控制器
• 意见
• 组件
• 混合

我在这里不包括 Handlebars 助手，因为我相信它们实际上是方法，而不是类，但如果我错了，我会纠正这个问题。