如何在JSDOC中记录对象数组
我有一个带有对象数组参数的函数，并希望使用 JSDOC 描述该参数（包括数组中对象的属性），就像这个示例一样：/** * @param {Array.<Object>} filter - array of filter objects * @param ... */ func...
JSDoc UML图解
问题: 我正在编辑和使用一个带有JSDoc标签的开源JavaScript库。我想知道是否有任何JSDoc插件可以让我从JSDoc标签中生成类图。 编辑: 我决定尝试 js/uml 并发现了以下内容。 JS/UML Eclipse扩展需要较旧版本的Eclipse（Indigo）和一个不受支持的...
jsdoc - 可以重复使用多个函数的文档吗？
我有一个带有大量选项的函数：/** * Show dialog in a blocking manner. * * @param {object} opts * @param {string} opts.msg "Body" of the dialog. * @param {numb...
在JSDoc中描述对象数组
我有一个函数，它接受一个对象数组。 看起来像这样。myAwesomeFunction([ { name: 'someName', next: false, test: 'test' }, { name: '...
AMD + Backbone + JSDoc3 最佳文档化方式
我正在寻找最好的记录代码的方式，但是我找不到任何东西。 我看过其他主题，包括这个，但它们都没有解决我的问题。 我有类似这样的东西： define([ 'backbone' ], function (Backbone) { /** * @module model...
能否使用JS Doc生成PDF文件？
我正在使用JS Doc 3版本（https://github.com/jsdoc3/jsdoc）。运行该工具时，默认情况下会生成HTML格式的文档。是否可以生成PDF格式的文档？
如何为具有不同类型键的对象编写JSDoc？
JSDoc API说，您可以像这样文档化对象： 请点击此处 。 {Object.<string, number>} 并记录多种类型： {(number|boolean)} 但是，如果我尝试指定一个既可以使用字符串也可以使用数字作为键的对象，则无法使用。VSCode/JS...
JsDoc：如何记录一个对象可以具有任意（未知）属性，但具有特定类型的信息？
这与问题30360391类似。我想表达的是函数的参数是一个普通的JS对象，它可以具有任意属性（具有未知名称），但所有属性本身都是具有固定属性的对象。 例如：函数就像这样。 /** * @param {Descriptor} desc */ function foo( desc ) { ...
JSDoc：返回对象结构
我该怎样告诉JSDoc一个返回对象的结构。我找到了@return {{field1: type, field2: type, ...}} description这种语法并尝试过： 如何在 JSDoc 中指定返回的对象结构？我看到了 @return {{field1: type, field...
JSDoc文档化socket.on('event', function() {})和路由处理程序的正确方法
如何使用JSDoc记录具有以下格式（单个文件）的API // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Object} da...