问题标签 [jsdoc]

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 回答
711 浏览

eclipse - Eclipse JSDT - 支持功能的完整列表?

有没有什么地方我可以得到 Eclipse 的 JSDT Javascript 支持中支持和不支持的最终列表?

Eclipse 提供的文档非常少。我对支持哪些 JSDOc 标记以及在哪里支持特别感兴趣,因为我的实验者正在产生相当混乱的结果。

我也对其他特性(完成、重构)的细节感兴趣。

谷歌搜索没有产生任何有用的东西

0 投票
1 回答
358 浏览

eclipse - Eclipse JSDT - declaring the type of a function argument

Using Eclipse Helios:

If I define a simple Javascript function

  • the tags were those automatically added by Alt-Shift0J - then the inferred type for the function is:

Note the "any arg", despite also Eclipse also recognising the parameter is "{String} arg" later.

Nothing I've tried get the inferred type of the arg to be anything other than "any". This means calling the function with a non-String isn't detected, which is a pity.

So, is this a bug? Not supposed to work? Something I'm doing wrong?

0 投票
4 回答
24399 浏览

linux - linux shell 将变量参数附加到命令

我正在尝试获取一个 bash 脚本,该脚本为这样的给定参数生成 JSDoc

我陷入了如何将未知数量的参数传递给下一个 shell 命令的问题。

(另外,不知道如何检查参数是否存在,只有在不存在时才 exitst if [ -z ... ]

此代码最多可用于两个参数,但显然不是正确的方法......

我将不胜感激任何其他关于我如何实现这一目标的指针。

编辑:根据@skjaidev 的回答更新脚本 - 快乐的日子;)

0 投票
4 回答
3104 浏览

javascript - 带有轻量级标记的 Javascript API 文档框架

我正在寻找一个 Javascript API 文档框架,其功能类似于 JSDoc,但会在代码注释(不是 html)中使用易于键入的重组文本或 markdown

奖励:将与 Sphinx 很好地集成。但是,我不想维护单独的文档,而是从注释中生成 API 文档。

http://code.google.com/p/jsdoc-toolkit/

0 投票
4 回答
1716 浏览

javascript - google 闭包的 typedef 实际上是做什么的?

我了解它的用途 - 我可以看到能够为复杂类型定义别名并在文档中使用它的好处。所以你可以定义一个类型,比如......

...然后用它来记录一个函数,比如...

但我不确定的是,如果它只用于文档和编译器的静态类型检查,那么为什么 typedef 需要那行 JavaScript?别名不能完全在文档注释块中定义吗?而且,如果您直接提供代码(不编译它),JavaScript 解释器会如何处理 typedef 注释之后的那行代码?

0 投票
4 回答
4501 浏览

vim - 在 Vim 中获取 jsDoc 智能感知的最佳方法是什么

我最近转换为使用 vim 并且完全被它卖掉了。

我还没有找到一种很好的方法来使用带有 ctags 的 jsdoc 注释来获得智能感知或跳转到函数的能力。

你怎么做到这一点?

0 投票
1 回答
4176 浏览

javascript - 如何在 JavaScript 中记录命名空间?

如何使用 jsDoc 在 JavaScript 中记录命名空间?

这是我的尝试,对吗?

只是为了澄清,上面的用法如下:

0 投票
1 回答
993 浏览

javascript - JsDoc 工具包和命名空间 - 警告试图 .. 没有

我将jsdoc-toolkitMike Koss 的命名空间库一起使用。代码看起来像这样

创建文档我收到以下消息,并且根本没有为此类创建任何文档。

我试图用参数线克服这个问题 - 没有成功。

知道如何克服这个问题吗?

0 投票
1 回答
1346 浏览

javascript - 指定在另一个文件中声明的全局变量的类型

我如何告诉我的 IDE (PHPStorm) 某些全局变量不是“未声明”,而只是在其他地方声明;并有特定的类型?

来自 Magento ( ) 的示例opcheckout.js

我想做的是这样的:

0 投票
1 回答
1644 浏览

javascript - 如何让 JSDoc 记录我的 _methods?

我有一个包含这个方法的类

它带有前缀_以将其与replace用于公共接口的方法区分开来。为什么 JSDoc_前面有 a 时不记录这个方法?如果我删除它,它会完美地记录下来。我能做些什么来让 JSDoc 记录这个方法吗?