问题标签 [yuidoc]

假设我用Object.defineProperties(). 如果我尝试使用 JSDoc 注释指定此属性的类型，WebStorm 会给我一个警告。

这是一个例子：

这会给我以下 WebStorm 警告：Initializer type {get: Function} is not assignable to variable type String。

如果我切换到以下内容，警告就会消失，但生成的文档并没有说需要一个“字符串”：

有想法该怎么解决这个吗 ？

YUIDoc似乎没有为我的命名空间生成任何文档。该项目使用Revealing Module设计模式

知道如何用 YUIDoc 记录方法参数，其中参数是向量，是一个三元素数字数组吗？

这就是我到目前为止所做的，将参数描述为简单的“数组（数字）”：

当您构建和运行 YUIDoc 时，它会从http://yui.yahooapis.com/.... 这些资源包括样式表和yui.min.js.
如何离线下载和使用这些资源？

这样做的原因是因为我们在 HTTPS 服务器上运行我们的文档。YUIDoc 总是通过 HTTP 协议提供他的文件。

我有一个需要文档的 ember-cli 项目，我正在使用ember-cli-yuidoc插件，这是我的yuidoc.json文件：

我想在我的login.js路线中链接到Ember.Route（它扩展它）。

生成的文档如下所示：

以上未能链接到正确的对象，我错过了什么吗？

我很难理解如何使用 YUIdoc 记录我的 Node API。

我有很多“看似简单”的问题。如何区分“路线”和“模型”？目前我正在使用“route.foo”和“model.foo”，但感觉完全不对。

我正在尝试使用 YUIDOC 自动生成文档，但是我有一个大量使用 python 的服务器端框架，所以我试图从 python 脚本中自动化所有内容。我能够让 node 命令正常运行，但是每当我尝试使用 npm 安装的东西时，python 都不高兴。我的项目使用 Buildout 而不是 virtualenv，但理想情况下，我希望能够从独立的 python 文件中运行这些命令。

也许一些代码可以帮助解释我的情况：

我已经尝试将 yuidoc 和 npm 内容所在的文件夹添加到 python 的 sys.path 中，但这不起作用。

ps，这是一个与this question类似的问题。

我正在尝试记录一系列 Polymer Web 组件。我过去使用过Polymer/core-docs-viewer，但发现它不像 YUIDocs 或其他类似 JSDocs 的那样完整和可扩展。YUIDocs 似乎是记录大型项目/前端和后端代码以创建单个可维护文档源的更好选择。

有没有办法让 YUIDocs 解析 HTML 注释块内或<script>自定义元素标签内的脚本块？

我试过了：

还：

到目前为止，YUIDocs 还没有在上面的评论中找到并添加我的类声明。

任何帮助表示赞赏。

我正在尝试在我的一个插件上从源代码构建文档。现在一切正常，但索引页面为空且无用。我想用类部分的内容替换索引部分，因为这是这个插件唯一有用的信息。

看起来索引部分无法访问类部分中可用的数据？

我附上了两张截图来说明我在说什么。第二个屏幕截图是我想在索引页面上显示的内容。我尝试在那里导入部分内容，但除了静态标题之外没有渲染任何内容。

@命名空间

@namespace 不应包含整个库挂起的“根”或“全局”对象。

因为我们有 @module ，它提供了 js 文件容器。有人可以给我一个最简单的例子吗？或引导我到某个链接