JSDocs：记录Node.js express路由
我在使用JSDocs记录router.get调用时遇到了困难。如果我尝试将文档附加到路由器调用本身，我无法使文档正确显示在页面上。/** * Health check * @memberof health */ router.get('/happy', function(req, res...
在JSDoc中描述对象数组
我有一个函数，它接受一个对象数组。 看起来像这样。myAwesomeFunction([ { name: 'someName', next: false, test: 'test' }, { name: '...
jsdoc错误信息：“没有要处理的输入文件”
已经本地安装了 Jsdoc (npm install jsdoc)。我尝试执行以下命令时出现以下错误： .\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js 输出如下： DEBUG: JSDoc 3.3.0-dev (...
JSDoc 二维数组
我有一个字符串的数组数组，但我不知道如何使用JSDoc进行文档化。/** @class */ function PostbackList() { /** @type {int} @default */ this.TypeID = 0; /** ...
如何在JSDOC中记录对象数组
我有一个带有对象数组参数的函数，并希望使用 JSDOC 描述该参数（包括数组中对象的属性），就像这个示例一样：/** * @param {Array.<Object>} filter - array of filter objects * @param ... */ func...
JSDoc - 如何记录原型方法
我一直在尝试使用JSDoc记录以下代码：/** * @module person */ /** * A human being. * @class * @param {string} name */ function Person(name){ this.nam...
直接从源代码生成JavaScript文档
我正在寻找一种工具，即使没有适当格式的注释块与这些函数或属性相关联（像Doxygen一样），也可以生成JavaScript函数和属性的文档。 这篇关于JSDoc和其他文档工具的比较的文章提到，JSDoc可以解析源代码以生成文档，即使没有注释块（就像我上面提到的Doxygen一样）。他们说所有...
使用@method还是@property来定义JSDoc对象方法？
JSDoc 3的文档包含以下示例： /** * The complete Triforce, or one or more components of the Triforce. * @typedef {Object} WishGranter~Triforce * @property ...
JSDoc的默认“主页”文本和内容
在从Node.js运行基本的JSDoc编译/渲染之后： jsdoc file1.js file2.js 我使用"out"目录中的默认模板获得了一个格式良好的文档。几乎所有内容都符合预期！ 但是在打开文档时，它总是在index.html页面上显示"Home"，该页面没有内容，并且在侧边栏...
JSDoc侧边栏中的嵌套方法
感谢在这里找到的答案： https://dev59.com/6WIk5IYBdhLWcg3we-L5#19336366 我的JavaScript文档组织得很好，格式也很好。每个命名空间都是包含方法的“父级”。但是，导航不够细致。 使用node.js工具通过简单的命令（jsdoc file...