-
225 votesanswersviews
如何在jsdoc中描述“对象”参数？
// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } 但是，我如何描述参数对象应该如... -
-1 votesanswersviews
在Angular项目上运行的JavaScript JSDoc
我正在开发一个Angular 4项目，我从Angular CLI构建 . 接下来我要安装JSDOC 我按照说明做了这个： - npm install -g jsdoc - npm install --save-dev jsdoc 所以，现在我安装了它 . 我的问题是......接下来我要做什么来生成doc文件？ 它在文档中说运行此命令： jsdoc yourJavaScriptFile.js “... -
0 votesanswersviews
如何使用JSDoc记录接受多个形状的对象？
让我们取一个参数 test ，它只接受 object 类型 . 要工作， test 可以采用两种形状： {key1: ..., key2: ... } 或 {key3: ..., key4: ... } 从JSDoc documentation开始，我知道可以通过这种方式记录param的属性： @param employee - 负责项目的员工 . @param employee.nam... -
0 votesanswersviews
摩纳哥JSDoc范围解析（匿名功能）
我正在使用NodeJS编写一个基于Web的“现代”MUD，我使用Monaco编辑器实现了在线编辑 . 我刚刚发现了一个非常烦人的问题，我的方法是定义MUD模块 . 导入的.d.ts文件不提供intellisense，因为全局范围中的类定义被过度重写： Workroom.js（简化）： MUD.include('Base').defineSingleton(I.Base.Room, function... -
2 votesanswersviews
如何使用JSDoc记录符号索引签名是否符合打字稿？
我使用普通的Javascript创建一个类并使用JSDoc记录它，我使用typescript进行类型检查 . 但我无法弄清楚如何正确编写JSDoc，因此它会识别使用Symbol的字段访问 . const secret = Symbol('secret'); class MyClass { constructor() { /** @type {Map<string,number&g... -
7 votesanswersviews
从JSDoc生成Swagger YAML？
我有一个用JSDoc完整记录的大型JS API，我正在构建一个基于swagger的REST服务，以使API在网络上可用 . 我手动构建了YAML swagger规范的初始版本，但问题是它很快与JS API不同步，因为它仍在不断发展，特别是在所涉及对象的属性中 . 我想要做的是直接从JSDoc注释自动生成swagger YAML，至少是它的数据定义部分 . 有没有可以帮助我实现自动化的工具？