问题标签 [jsduck]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
202 浏览

extjs - 如何阻止 JSDuck 生成的文档类名称重叠

我正在使用 JSDuck 来记录我的 extjs mvc 项目中的 JS 类,但是在 API 文档的主页上,所有记录的类的名称都相互重叠,因为类名很长。虽然我意识到减少类名的长度将是一个很好的解决方案,但这是不可行的。

请看下面的问题

两个木偶

任何帮助是极大的赞赏。

0 投票
0 回答
511 浏览

ruby - Jsduck gem 的安装问题

我正在尝试在我的 Mac JSduck上安装

  • OSX 小牛队 10.9.2
  • 存在 Xcode 命令行工具

但是发现以下错误

在此处输入图像描述

0 投票
1 回答
134 浏览

javascript - 跨多个方法记录相同的 jsduck 配置类型

两个问题:

首先,有人知道如何继承某些文档的一部分吗?专门针对“选项”对象:

基本上,我希望该文档采用多种方法,但我不想将其复制到每种方法中,并且我想要一个共同的地方来更改它。

其次,如果我可以通过某种方式继承文档,我可以扩展它吗?例如我想要:

0 投票
1 回答
127 浏览

javascript - jsDuck javascript/jQuery 推荐的记录 $.trigger 的方式

在 jsDuck 中记录的最佳方式是什么:

0 投票
2 回答
629 浏览

javascript - 打字稿文档生成器

我开始用 jsDuck 记录我的 java-script + typescript 网站我已经很好地记录了我的类,但我的问题是接口 - 它们不会从 ts 文件编译到 java-script。

这是我的输出,因为你可以看到页面不知道谁是IComboBoxScope 当然它是可以理解的,因为它没有生成到 java 脚本

http://i.stack.imgur.com/PIVKe.jpg

在jsDuck中是否有解决此问题的正确方法?

如果没有,是否有其他产品或解决方案可以用 typescript 记录 js?,maaybe jsDoc?,类型文档

抱歉,样本/照片不佳,我正在使用专用网络。

0 投票
1 回答
739 浏览

javascript - 如何记录(jsduck/jsdoc)cucumber.js 步骤定义?

有没有办法在 cucumber.js 步骤定义代码中记录步骤?我试图用 jsduck @class 来模拟它:

但是 jsduck 只识别最后一步的描述。

0 投票
1 回答
197 浏览

jsduck - JSDuck 指南:如何生成小节导航?

我正在使用 JSDuck 的 Guides 功能,我在 guides.json 文件中指定 README.md 文件。

我遇到的问题是我无法在 guides.json 的 README.md 文件中指定锚点。

例如,我的 README.md 文件有一个 H1 头,然后是 5 个 H2 头。假设在每个 H2 标头上方,我放置了一个锚点——例如<a name="h2_1">, <a name="h2_2">,<a name="h2_3">

我想要标题:(参数)我在 guides.json 中输入的内容出现在页面左侧的 JSDuck 生成的导航中。所以,假设我输入了这些参数:

问题是 -section tail - 这是 JSDuck 中的有效链接引用导致解析器无法将 README.md 呈现到目录“foo”中的目标 README.js 中。

任何人都有任何建议 - 如果一个人不能在指南的主导航中表达小节,那将是一个巨大的障碍。

0 投票
1 回答
186 浏览

extjs - 在 JSDuck 文档中列出 ExtJS 4 自定义命名空间

ExxtJS 4 JSDuck 6

我有一个带有许多 ExtJS 应用程序(即 MyApp)的 ExtJS 工作区(MyWS)。工作区中有一个 overrides 文件夹 (MyWS.overrides)。

JSDuck html 文档的左侧面板中列出了“Ext”、“MyApp”和“MyWS”命名空间,但“MyWS.overrides”命名空间没有。

如何列出“MyWS.overrides”命名空间?

0 投票
1 回答
99 浏览

jsduck - jsduck 5.3 创建 PHP-Doc

今天我用我的 ExtJS 项目试用了 jsDuck 5.3。它真的很好用。但我也评论了 PHP 中的每个方法和类。我已经看到 JSDuck 3.11.2 可以从 PHP 文件创建完美的在线文档,但 JSDuck 5.3 不能。是否可以将模块或插件加载到 JSDuck 5.3?或者还有其他做法可以通过 jsDuck 5.3 获取 php-doc 吗?

0 投票
1 回答
132 浏览

jsduck - 为什么 JsDuck 会忽略排除目录?

我使用 JsDusk

  • 版本:JSDuck 5.3.4 (Ruby 1.8.7)
  • 操作系统:Linux(CentOS 6)

我想排除一些目录,但它不起作用。

实际上它应该有效。这是 jsDuck 代码

我使用以下命令在脚本中启动 jsDuck。