jsdoc 相关问题

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

如何将JSDoc与通用打字稿一起使用?

将JSDoc用于一般打字稿功能的最佳方法是什么。下面是我尝试过的方法,但是我想有一种最佳方法,因为有信息说JSDoc类型可能会被移动...

回答 1 投票 0


如何记录在JSDoc字典?

有下一个例子:var CONF = {区域设置:{ “恩”:{名称: “英语”,郎咸平: “EN-US”}, “ES”:{名称: “西班牙”,郎咸平: “ES-ES”。 ..

回答 2 投票 44

如何使用jsdoc出厂的功能呢?

所以我有一个出口工厂功能的模块。工厂函数接受设置并返回绑定在该设置对象库。我不能为我的生活弄清楚如何记录?

回答 1 投票 1

与JSDoc记录工厂

为了避免用我的JavaScript代码新的,我写的工厂来创建对象。我已经尝试了许多组合,让我最满意的结果之一是:/ ** * ...

回答 2 投票 8

如何包括和排除目录与documentationjs解析

特别是,我感兴趣的是排除任何node_modules文件夹,但也有其他需要被排除在外。这通常是完成在配置文件;例如,一个.jsdoc文件,像这样:” ...

回答 1 投票 1

文档对象在JSDoc方法及其返回值

我有一个寻呼控制器工厂,返回一个寻呼控制器对象了一堆的方法(视图与互动,尤其是当最终用户确实喜欢浏览到一个动作...

回答 1 投票 1

在打字稿JSDoc约束泛型

我使用打字稿的JSDoc形式,我试图用一个通用的扩展的对象。我的编辑是给我一个打字稿错误的index.js码声明typeMyInterface&的参数...

回答 1 投票 1

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

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