问题标签 [jsdoc]

简单的问题，我如何记录“混合类型”？我知道我可以列出所有可能的类型，例如{null|undefined|String|Number|Object}，最终发现自己错过了一种并使其过于复杂。我尝试使用 Mixed 关键字，但它在许多 IDE（例如 WebStorm）中弹出错误。

我正在寻找构建不需要加载所有源文件来播放应用程序的系统的方法。我过去的项目有超过 200 个 .js 文件（我不是在开玩笑！），并且重新加载页面以测试您开发的功能真的很慢。

我查看了 Dojo，看到了他们是如何构建动态加载器的。基本上你只需加载一个核心组件，然后在需要时加载其他所有组件。

我正在考虑在我的应用程序中实现一个工厂方法，它允许我在 JavaScript 中构造对象的新实例：

代替：

我想放弃 new 关键字的原因是因为前一种方法允许我以延迟加载的方式动态加载组件，如果它不存在的话。工厂方法可以只查看目标对象是否已定义，如果未定义，则加载它。

我面临的唯一问题是 IDE 不再理解的事实user是类型MyApp.model.User肯定不是一件好事。

有没有办法解决这个困境？我可以以某种方式 JsDoc 那个工厂方法吗？

您好我正在尝试将自定义标签添加到 JSDoc-toolkit。我发现的唯一有用的网站是：使用自定义标签，但它不起作用。

我也尝试过{+data.comment.getTag("customTag")[0]+}，但没有运气。

通过 Closure Compiler 运行一个相当大的库时，我收到了很多"Unknown type"警告，当我的类型在自执行匿名函数中声明时，它们似乎发生了。这并没有什么特别之处，但是如果我去掉自执行函数，类型声明似乎可以工作（至少在这个简单的测试中）。

我不确定我的代码注释是否有问题，或者代码中是否有任何非法内容，但我认为这完全符合犹太教标准，也是模块化 API 的标准方法。

下面的测试代码创建了一个命名空间（只是一个普通的旧 JS 对象）并附加了一个枚举（一个对象字面量）和一个函数。

看起来不错，对吧？闭包编译器错误：

我在内部声明了一些函数，jQuery(document).ready(function {})并为它们编写了 JSDoc 注释。问题是，当我专注于函数调用行时，它们不能显示为工具提示。但是，这不是必需的，也许有解决方案？我正在使用 Aptana IDE。我搜索了他们的文档并用谷歌搜索，但没有找到答案。

我正在努力使用 jsdoc-toolkit 以以下格式记录代码。在我看来，我使用的标签应该会产生预期的结果，但事实并非如此。相反，它警告 Class 是未记录的（因为它仅在闭包内定义）并且不包括 Class 在命名空间的成员列表中。

如果可能的话，我想在不使用@name 标签的情况下记录这一点。任何人都可以帮忙吗？

我正在使用 ADVANCED_OPTIMIZATIONS 编译级别的 Google Closure Compiler 并开始注释我的构造函数，因为我收到了各种警告：

警告 - 危险地使用全局 this 对象

对于我的“构造函数”类型函数，我将像这样注释它们：

这似乎工作正常，但是如果我有一个不是用 var myFoo = new Foo(); 构造​​的“单例”对象怎么办？我在文档中找不到如何注释这种类型的对象，因为它的类型只是对象，对吗？

这是交易，

如果您使用过 Aptana、Eclipse 甚至 Microsoft Expression Web 编辑器，那么您已经看到它们具有气球文本或Intellisense 弹出窗口，显示内置和自定义对象、方法等的提示/信息。

他们通过 JSDoc、PHPDoc、JavaDoc、RDoc 等获取信息。

我想在 Vim 中获得这些功能，可能实现为omnicompletion，而且因为 Mac/GVim 也支持气球文本，这也是。

根据@param 的JSDoc wiki，您可以使用@param 表示可选

并且您可以使用以下方式指示参数内联

我可以像下面这样组合它们，效果很好。

但我想知道是否有办法在可能的情况下内联。

如何在 jsdoc 中记录可变参数？有没有办法记录类型的参数，如“字符串数组”？