问题标签 [jsduck]

放置处理事件的类（例如 ExtJS 子类）的方法的最佳 jsduck 标头是什么？Jsduck 似乎支持与 jsdoc 相同的标签，但我不确定@event 标签是否合适。

JSDuck在生成的文档中提供用户反馈。Sencha 在他们的代码文档中使用了这个。它在博客文章中有所描述。

我也想为我们的开发团队使用该评论功能。

谁知道该怎么做？

我正在探索 JavaScript 文档工具，发现 JSDuck 令人印象深刻。我注意到 appcelerator 钛也使用它。但是，找不到太多关于使用它来记录不使用 Sencha 的 JavaScript 框架的代码的信息。关于如何以及是否可以用于记录任何 Javascript 代码的任何建议？

示例：有几个 .js 文件具有几个功能，例如：

JsDuck.exe 创建帮助文件后 - 函数描述中不存在函数参数，仅返回值 bRes 和描述。版本：SDuck 5.0.0.beta2 也尝试过早期版本，结果相同。

有没有人将 JSduck 用于功能框架并获得成功。还是有任何解决方法可以正常工作？

相同的 .js 文件可以与 JSDoc 工具包一起正常工作，并显示所有数据，但 JSDuck 仍然更适合使其工作。

提前感谢您的回复。

我想找到一种使用 phpdoc2 将 PHP 项目解析为 JSON 而不是抽象语法树 XML 的方法。虽然我当然可以将 XML 解析为 JSON，但在这里创建 XML 似乎是不必要的开销。

所以，简而言之，问题是：有没有一种简单的方法可以将 phpdoc2 的解析器配置为直接生成 JSON 而不是 XML？或者也许有一些关于在 phpdoc2 中扩展什么以将解析输出路由到 JSON 的线索？

这个问题背后的故事是：我想为我的 PHP 项目创建类似 JSDuck 的文档。虽然我发现JSDuck 可以用于 PHP 项目，但我不会这样做，原因有两个：

1. 不想在我的 PHP 类中使用 phpdoc 注释或在其中添加一些 JSDuck 特定的东西；
2. 不需要整个 JSDuck 文档界面，因为我将自己创建一个非常自定义的界面；
3. 首选 PHP 解决方案。

我正在为我的 JS 库寻找文档生成器。我发现JSDuck是最全面、最强大的一个。但是我看不到使用其语法为泛型类和函​​数定义类型变量的方法。快速浏览一下流行的 JS 文档生成器让我觉得它们都没有这样做的能力。这是我正在寻找的伪示例：

样本输出：

MyArray<T>
我完美的数组类。

BirdArray<T extends Bird > extends MyArray <T>
请使用这个很棒的数组类来计算鸟类。

有没有办法在 JSDuck 中实现这一点？如果没有，是否有一些 JS 文档生成器可以为我做到这一点？请假设它应该像 JSDuck 一样通用，以确保我能够使用任意类继承模式。

我已经用 JsDuck 生成了文档。我注意到的一件事是，尽管我在在线文档中看到了指南，但没有打印按钮？

构建文档时如何在配置文件中启用它？如果不可用，我应该如何格式化 url 以获得可打印版本？

可打印版本的示例如下

http://docs.sencha.com/extjs/4.0.7/?print=/api/Ext.ComponentQuery#

试过了http://localhost:50005/?print=/api/SLMS.db.Functions，它只是加载了相同的页面。

我有一个带有注释的 JavaScript 库，可以使用 JSDuck 生成文档。我认为这样的注释足以为我的库提供良好的 IntelliSense。此外，它们非常标准，因为 JSDuck 语法被设计为流行的 Google Closure Compiler 语法的扩展。但似乎没有 IDE 使用代码注释来提供 IntelliSense。有许多“智能”引擎试图建议变量的类型，但没有“可靠”引擎读取注释甚至确定我的库有哪些类。

如果有用，这里是指向我的库及其由 JSDuck 生成的文档的链接。

我想在 Visual Studio 中为 js 方法生成注释存根。

有一个名为“JScript vsdoc Stub Generator”的评论存根生成器http://visualstudiogallery.msdn.microsoft.com/e122a031-d748-41e9-87b1-7b56d8610d8b

但我想使用 JsDuck 生成文档。

所以应该像下面这样评论使用 jsDuck

有人知道 Visual Studio 的扩展来完成这项工作吗？

我在 Solaris 上运行 JSDuck v5.3.4，带有一个非常简单的输入文件：

我像这样运行它：

当我尝试浏览生成的内容时，我看到了巨大的加载设备和绿色的 JSDuck 横幅，但它永远不会结束。在 Chrome 检查器控制台上，我看到一个 JS 错误：

我可以使用独立的 Win32 JSDuck 可执行文件（也是 v5.3.4）在 Windows 上很好地生成这个文档

我将不胜感激任何帮助找出我可能做错了什么！生成的输出中没有源映射，我也找不到任何方法来禁用 Ext4 捆绑版本的缩小或源映射。考虑到这是最常见的 JS 错误，对这个“Uncaught TypeError: ...”进行搜索并没有什么成果。