问题标签 [jsdoc3]

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 投票
3 回答
14855 浏览

javascript - 带有@method 或@property 的JSDoc 对象方法?

JSDoc 3 的文档包括这个例子:

我本质上是在创建一个类,该类接受一个实现接口的对象,该接口MessageQueueConnector应该connectAndSubscribe实现一个方法。由于 Javascript 不区分成员函数和成员变量,因此使用属性是有意义的,而 JSDoc 的文档暗示这@method是无关的。但是,方法听起来更正确,所以我想知道这是否是首选,或者我是否只是做错了所有这些(即,如果有一种更简单的方法首先记录这种情况,而无需创建类型)。

0 投票
2 回答
575 浏览

javascript - JSDoc3:如何记录返回函数的 AMD 模块

我正在尝试找到一种使用 JSDoc3 记录 AMD 模块的方法。

遗憾的是, http://usejsdoc.org/howto-commonjs-modules.html中列出的所有模式都不适合我。

如何生成适当的文档,列出模块导出的函数的参数和返回值?

0 投票
1 回答
1037 浏览

jsdoc3 - 如何让 JSDoc3 记录模块功能

鉴于此文件

我没有从 JSDoc 获得任何文档。它创建一个module-stuffutils.html但文件基本上是空的。

我在函数文档中尝试/** @exports getStuff */了定义之上,定义之下。我尝试了各种形式的@static, @alias, @public. 我能得到的最好的结果是它显示为一个全局函数,这显然不是我想要的。想法?

jsdoc

我试过这个似乎遵循文档

但即使这样也行不通。

jsdocs 输出 2

文档被插入两次。记录了两个函数而不是一个。GetStuffCallback没有记录。我无法移动 的定义,getStuff因为其他函数使用它。换句话说,如果我只是将其设为分配给的对象的匿名函数,exports我将无法从该模块中调用它。我的意思的例子

希望您能在上面看到为什么函数不能是导出对象的匿名值。

0 投票
0 回答
87 浏览

jsdoc - JSDoc3 - 对象文字的整洁组织

我绝对是 JSDoc 和类似 Javadoc 的约定的新手;我正在寻找一些容易实现的目标来启动和运行,但我做不到了。

我的代码是这样组织的,主要是个人风格:

从理论上讲,一切都可能只是“应用程序”下的一个整体对象,但我喜欢单独分解下一级对象,以便在 IDE 中方便地进行冷折叠和搜索。另外,这样对我来说感觉很整洁。

我无法做到的是深入研究第三级功能和对象。JSDoc3 似乎不想为我呈现它;此外,我不喜欢将“应用程序”(或者我最后给应用程序的任何内容)作为名称空间的起始页面......我希望它的成员也可以在索引中。这是我的尝试(原谅愚蠢的例子!):

有两个问题:

  1. 理想情况下,我希望 app.ui 拥有自己的页面。@namespace 是正确的方法吗?它可以工作,但在视觉上它在索引中伪装成与应用程序本身处于同一级别。

  2. app.ui.init 根本没有记录。

在我看来(诚然,这可能只是无知!)如果我使用 JSDoc3 会更开心:

但就我而言,这将是相当丑陋的。我需要用来指示嵌套成员的任何语法指针都是我所追求的。

0 投票
1 回答
1518 浏览

javascript - 使用 JSDoc-3.3.0-alpha5 记录原型属性和方法

我有一个名为的类,我已经尝试记录它,但是在输出文件中没有生成FileDownloader使用声明的属性和方法。prototype

如标题所述,我使用 jsdoc 3.3.0-alpha5。

这是代码:

这是生成的文档:

任何想法?

0 投票
2 回答
566 浏览

node.js - Nodejs 上的 JSDoc 给出 TypeError: undefined is not a function

我想使用在 Nodejs 上运行的 JSDoc 为我的 javascript 项目生成自动文档。我做了以下事情:

  1. 安装的 Nodejs
  2. 从 nodejs 安装 jsdoc 如下: npm install jsdoc

一切似乎都很顺利。然后,我在一个示例 javascript 文件上运行 JSDoc:

c:>jsdoc d:\version.js

C:\Users\Mark\AppData\Roaming\npm\node_modules\jsdoc\cli.js:341 packageDocs = new Package(props.packageJson); ^ TypeError: undefined is not a function at Object.module.exports.cli.parseFiles (C:\Users\Mark\AppData\Roaming\npm\n ode_modules\jsdoc\cli.js:341:19) 在 module.exports。 cli.main (C:\Users\Mark\AppData\Roaming\npm\node_modules\j sdoc\cli.js:232:14) 在 Object.module.exports.cli.runCommand (C:\Users\Mark\AppData\ Roaming\npm\n ode_modules\jsdoc\cli.js:189:5) 在 C:\Users\Mark\AppData\Roaming\npm\node_modules\jsdoc\jsdoc.js:178:13 在 Object. (C:\Users\Mark\AppData\Roaming\npm\node_modules\jsdoc\ jsdoc.js:180:3) 在 Module._compile (module.js:456:26) 在 Object.Module._extensions..js (module .js:474:10) 在 Module.load (module.js:356:32) 在 Function.Module._load (module.

请注意,无论我从哪里运行 jsdoc 以及使用哪个 javascript 文件,我都会收到此错误。

任何人都可以帮忙吗?

更新 如果我删除 cli.js 中的第 341-343 行,一切正常。这三行是否可能特定于特定(即非 Windows)环境?

0 投票
5 回答
34674 浏览

javascript - 用 jsdoc 记录回调的正确方法是什么?

我花了很长时间在互联网上寻找使用 jsdoc 正确记录回调的最佳方法,但不幸的是,我还没有找到一个很好的方法。

这是我的问题:

我正在为开发人员编写一个 Node.js 库。该库提供了开发人员将使用的多个类、函数和方法。

为了使我的代码清晰易懂,以及(希望)将来自动生成一些 API 文档,我已经开始在我的代码中使用jsdoc来自我记录正在发生的事情。

假设我定义了一个如下函数:

使用 jsdoc,我目前正在记录此功能,如下所示:

我觉得上面的解决方案有点hack-ish,因为我没有办法绝对指定回调函数应该接受什么。

理想情况下,我想做类似的事情:

以上似乎可以让我更简单地传达我的回调需要接受的内容。那有意义吗?

我想我的问题很简单:用 jsdoc 清楚地记录我的回调函数的最佳方法是什么?

感谢您的时间。

0 投票
2 回答
3099 浏览

node.js - @type 来自 node.js 的“导出模块”和良好的文档描述?

我正在努力成为一个好公民并记录我的节点模块....但我不确定在@type 中放入什么。我正在使用 webstorm,所以它会自动放置 @type {exports} 但我有点困惑我应该在那里放置什么?

有人帮我一把吗?这是我正在开发的一个小模块,删除了代码以更好地强调问题。我对我应该使用什么@type 以及如何用一个好的描述记录导出和要求感到困惑。

@type {exports} 是有效标签吗?

任何人都知道一个好的标准或给出意见/他们将使用/或正在使用什么

0 投票
1 回答
6237 浏览

javascript - The error message "There are no input files to process" from jsdoc

Jsdoc is installed locally ( npm install jsdoc ). I get the following error while trying to execute .\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js Output: DEBUG: JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT) DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknownTags":true},"templ ates":{"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles" :true}},"source":{"includePattern":".+\.js(doc)?$","excludePattern":"(^|\/|\\ )_"},"plugins":[]},"opts":{"_":["./lib/JavaScriptSource.js"],"debug":true,"destina tion":"./out/","encoding":"utf8"}}} There are no input files to process.

0 投票
1 回答
413 浏览

javascript - JSDoc 中是否有 Implements 或 Extends 注释?

我知道有一个抽象注释,所以我期待反向注释。即实现(或扩展)和抽象方法的子类型方法。

我似乎在 JSDoc 参考中找不到任何内容。