问题标签 [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 回答
2369 浏览

pdf - JsDoc 到 PDF 渲染器

有谁知道将 JsDoc 转换为 PDF 的工具?或者您必须通过将 HTML 文件转换为 PDF 来做到这一点?感谢您的回答!

0 投票
2 回答
2148 浏览

javascript - 如何在 jsdoc-toolkit 中包含已记录的方法?

我有一个使用闭包方法创建的 JavaScript 单例对象:

但是jsdoc-toolkit不会生成从_foo方法到foo我想要的方法的继承文档。

如果我写@see而不是@borrows它起作用(插入指向正确方法的链接),但我不想复制并粘贴该foo方法的文档以获得公共文档。

0 投票
3 回答
10024 浏览

javascript - 为什么 jQuery 不使用 JSDoc?

还是他们只是不在源头中?我真的很想得到一些东西来阻止 js-doc-toolkit 每次解析 jQuery 时都吓坏了。这也意味着我不能正确地记录使用 jQuery 作为依赖项的任何代码,而至少要放置一些样板 js-doc 块,这些块无法正确记录 jQuery 的结构。有我不知道的通用解决方案吗?我试过谷歌搜索,顺便说一句。

0 投票
3 回答
6052 浏览

javascript - IntelliJ IDEA 中的 JSDoc 支持

是否有关于两种 IntelliJ 支持的JSDoc子集、超集或混合的文档?我使用 JSDoc 的动机有两个:

  1. 对于开发人员:因此 IntelliJ 可以提供更好的代码完成、代码检查、错误检查等。
  2. 为了运行时效率:使用Closure 编译器

对于上面的#1,使用 IntelliJ 支持的 JSDoc 标记对我来说很重要,直到现在弄清楚这一点主要是一个反复试验的过程。

0 投票
4 回答
2571 浏览

javascript - Google Closure Compiler 100% 输入

关于 google 闭包编译器,我怎样才能让我的应用程序 100% 输入?

我已经用 jsdoc 注释标记了所有内容。甚至有可能获得100?我在 64.6%

0 投票
5 回答
8849 浏览

javascript - jQuery 兼容的 JavaScript 文档生成器

我需要为我的 javascript 项目(使用 jquery、下划线和主干构建)选择一个文档生成器(类似于 java 中的 jdoc 或 ruby​​ 中的 rdoc)

候选人:

要求

  • 应该与 jquery、下划线和骨干一起使用。这意味着对象文字方法等
  • 真的很喜欢 pdoc,但它太以原型为中心,文档记录很差,而且我不想制作额外的文件(部分?)来使其工作(不确定这一点)
  • docco 很好,但我想要结构化输出(如菜单 + 类/函数结构,如 jdoc)
  • 必须与命令行/makefile 兼容(不是网络粘贴)

非常欢迎提示、技巧、教程、成功案例和建议。


为什么 jQuery 不使用 JSDoc?

0 投票
1 回答
294 浏览

javascript - Google 为其 JS API 文档使用什么文档标准?

乍一看,它看起来像 JSDoc 或 jsdoc-toolkit,但我看到两者都没有定义的标签。我在 Google JavaScript Style Guide 中读到他们正在使用 JSDoc,但公共源代码中有许多非 JSDoc 标签,因此我很好奇。

0 投票
4 回答
29644 浏览

javascript - 在 JSDoc 中记录开放式参数函数的正确方法

假设您有以下内容:

您将如何正确记录此函数可以在 JSDoc 中接受任意数量的参数?这是我最好的猜测,但我不确定它是否正确。

相关:php - 如何记录可变数量的参数

0 投票
5 回答
46883 浏览

javascript - 如何在 JsDoc 中返回 void?

在 JsDoc 中是否有指定的方法来声明返回 void 的方法或函数?目前我认为void是默认返回值,其他返回值必须具体提供:

0 投票
2 回答
6020 浏览

javascript - JsDoc如何进行多重继承或mixins?

如何记录混合或多重继承?

JsDoc有什么官方的吗?如果不是,那么你希望它怎么写?