JSDoc：返回对象结构
我该怎样告诉JSDoc一个返回对象的结构。我找到了@return {{field1: type, field2: type, ...}} description这种语法并尝试过： 如何在 JSDoc 中指定返回的对象结构？我看到了 @return {{field1: type, field...
如何使用jsdoc记录回调的正确方式？
我在网上搜索了很久，寻找用jsdoc正确记录回调函数的最佳方法，但不幸的是，我还没有找到一个很好的方法。 这是我的问题： 我正在为开发人员编写一个Node.js库。该库提供多个类、函数和方法供开发人员使用。 为了使我的代码清晰易懂，并且（希望）能够在未来自动生成一些API文档，我开始在我...
JSDoc中@param类型的枚举
在JSDoc的@param类型声明中是否可以像下面的例子一样使用enum？/** * @enum { Number } */ const TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ f...
如何使用JSDoc记录由函数返回的函数
我正在使用 JSDoc 进行参数文档的编写。 对于 many_prompts 的参数类型，如何进行文档编写已经很清楚了，但是如何对其返回的函数进行文档编写呢？/** * @param {Number} - number of times to prompt * @return {Func...
本地变量的正确JSDoc语法是什么？
对于这样的函数......function example() { var X = 100; ... var Y = 'abc'; ... return Z; } 我需要解释一些本地变量的目的。添加这样的描述...function example() { /**...
如何为嵌套对象的方法编写JSDoc文档？
我一直在尝试使用JSDoc3来生成文件的文档，但是我遇到了一些困难。这个文件（是一个Require.js模块）基本上看起来像这样： define([], function() { /* * @exports mystuff/foo */ var foo ...
JSDoc与AngularJS的结合
目前在我的项目中我们正在使用JSDoc，最近我们开始实施Angular，并且我希望继续使用JSDoc以确保所有文档都在同一位置。 我看过很多人主要只是建议使用ngDoc，但这并不是一个可行的选择，因为我们将始终有单独的JavaScript文件，我更希望所有文档都在一起。/** * @aut...
JSDocs：记录Node.js express路由
我在使用JSDocs记录router.get调用时遇到了困难。如果我尝试将文档附加到路由器调用本身，我无法使文档正确显示在页面上。/** * Health check * @memberof health */ router.get('/happy', function(req, res...
JSDoc侧边栏中的嵌套方法
感谢在这里找到的答案： https://dev59.com/6WIk5IYBdhLWcg3we-L5#19336366 我的JavaScript文档组织得很好，格式也很好。每个命名空间都是包含方法的“父级”。但是，导航不够细致。 使用node.js工具通过简单的命令（jsdoc file...
JSDoc的默认“主页”文本和内容
在从Node.js运行基本的JSDoc编译/渲染之后： jsdoc file1.js file2.js 我使用"out"目录中的默认模板获得了一个格式良好的文档。几乎所有内容都符合预期！ 但是在打开文档时，它总是在index.html页面上显示"Home"，该页面没有内容，并且在侧边栏...