jsdoc 相关问题

JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。

PhpStorm警告使用jQuery参数

我用PhpStorm,它是给我警告,当我定义的参数与JSDoc一种类型的jQuery。我试图jQuery的配置为库,但它似乎没有工作。这是我的代码:/ ** * @ ...

回答 2 投票 0

如何记录在jsDoc一个HTML节点功能?

我需要添加附接到这样的节点的功能:myElement = querySelector(“#myElement”); myElement.moveMe =()=> {//移动我的代码; }但我不知道如何记录这个功能(...

回答 2 投票 0

如何使用JSDoc 3和Babel.js的装饰器?

我想用类似Point {constructor(x,y){// ...} / ** *的装饰器来评论带有装饰器* / @test()val的变量; getX(){// ...} getY(){...

回答 1 投票 1

VS代码中的JSDoc,用于记录具有模块类型的函数

我想记录一个用另一个模块编写的函数,它使用http.ClientRequest类型参数。我想要这样的东西,但它不起作用:/ ** * @param {ClientRequest} req * / ...

回答 3 投票 5

JsDoc:将param类型定义为来自外部模块的类型

这似乎应该有一个明显的答案,但我找不到它。 var mongoose = require('mongoose')/ ** * @param {Mongoose.Model} fooModel * / function ExecuteAQueryUsingModel(fooModel){我...

回答 1 投票 5

jsdoc和vscode:将作为参数传递给另一个函数的函数记录下来

我正在尝试将输入参数记录到javascript中的函数,但我无法弄清楚如何在jsdoc中执行此操作。我查看了jsdoc文档,它建议使用@callback ...

回答 2 投票 2

定义指令的参数类型

如何在angularjs中定义指令的参数类型?什么类型的&绑定?请参阅示例代码中的ngdoc或jsdoc。 UPD:我的目标是获得以下问题的答案* @ ...

回答 1 投票 0

如何在JSDoc中记录事件处理程序? [关闭]

假设我有一个这样的类:function myClass(q){this.someFunction = function(e){console.log(“Click event”); }; jQuery的(Q)。单击(this.someFunction);有没有办法表明......

回答 2 投票 5

如何使用像lodash这样的JSDoc对参数进行分组?

我想知道lodash如何根据用户输入的参数类型或数量对参数的参数进行分组,如下图所示:在上图中,它可以...

回答 1 投票 2

来自Promise.All的JSDoc数组

我尝试记录Promise.all结果,因为一旦我解构数据,类型就会丢失。这是一个例子,(我试图欺骗它将promise放在一个闭包中)const promiseAll =()=&...

回答 1 投票 0

阵列。 或数组 ?

数组表示法的正确JSDoc格式是什么?阵列。 或数组 ?我已经看到这两个可以互换使用,不知道是否存在差异。当它......

回答 1 投票 1

jsdoc:多行描述@property

我正在使用jsdoc记录我的代码,到目前为止很好,我有如下评论... * @property {string}模式 - 显示'视频'模式 - 显示视频或'音频' - 只播放音频。 * @ ...

回答 2 投票 4

如何在启用了@ts-check的protractor.conf.js中定义类型

在我的Angular CLI v7.3.6项目中,我有一个protractor.conf.js文件。我想在我的VSCode中启用此文件中的@ ts-check。当@ ts-check被打开时,我想在...中调用browser.getCapabilities()

回答 1 投票 1

代码块中的jsdoc @字符

我正在尝试为这样的Module函数编写文档:/ ** *用法:* *```* @NgModule({* imports:[* BrowserModule,* ...,* ThisModule.forRoot(...

回答 2 投票 4

JS Doc注释链接方法JSDoc3

在JavaScript评论中,我想提一下某个文件中存在的方法。如何在评论中链接到该方法?例如。假设我的方法是:function xyz(){}并且说我正在写一个像//这样的评论...

回答 1 投票 1

在Node.js中混合使用JavaScript和TypeScript

虽然在ES6中有部分Node.js,但是可以在同一个项目中混合一些Typescript模块吗?例如。在TypeScript中定义了一些通过require导入的类型...

回答 1 投票 9

在函数的参数中使用jsdoc inline

目前我引入了一个名为data的参数,所以我可以给它一个类型:/ ** * @type {HomeOverview} data * / const data = {id:homeId,name:home.name,notificationCnt}; sails.sockets ....

回答 1 投票 1

如何在代码中读取函数描述?

我有这个代码/ **这是测试函数* @param {} param1这是param 1 * @param {} param2这是param 2 * / function test(param1,param2){}我正在寻找一种方法得到这个js ......

回答 1 投票 1

如何在JSDOC中扩展typedef参数?

假设您在ES6类(文档)中有以下代码:/ ** * @typedef Test~options * @type {object。 } * @property {array} elements - 包含元素* @的数组...

回答 2 投票 17

有没有办法在JSdoc中指定通配符导出?

在我的项目中,数据库模型是从models文件夹动态加载和导出的。我想要做的是在JSdoc中指定任何module.exports属性是一种Sequelize ....

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.