jsdoc 相关问题

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

带有已通过类型定义的JSDoc在VSCode中进行类型检查

我正在尝试使用JSDoc和VS Code进行类型检查,我想知道是否可以通过一种方法来进行类型检查,即先设置类型,然后再设置上述类型时...

回答 1 投票 0

如何从index.d.ts文件中手动导入类型,并告诉VS Code intellisense变量属于该类型?

我有以下问题:我正在基于Express.js(使用纯JS,而不是TS)构建一些程序。我正在使用Sequelize作为ORM。我有“存储库”类,这些类从...

回答 1 投票 0

JSDoc,类型变量

我们可以在JSDoc中使用类型变量吗?例如,我想定义身份函数:/ ** * @param {a} x * @return {a} * / const id = x => x;但是当我将其与具体类型id(2)一起使用时,编辑器...

回答 1 投票 0

JSDoc无法在具有汇总功能的.MJS文件中使用

我有以下... / ** *表示基本元素* @extends HTMLElement * @constructor * / export class Base扩展HTMLElement {...}当我运行时... jsdoc src / jrg-base-element .mjs然后...

回答 1 投票 0

jsdoc如何具有静态属性

我如何在这里获得有效的设置?我想使用静态类_Test.list来记录id属性,但无法在vscode中使用intellisense找到正确的方法。所以所有数字都不是...

回答 1 投票 2

JSDoc中对象中任意键的值的文档结构

我有一个函数工厂:function factory(events){for(事件中的const key){const {before,after} = events [key]}}其中,参数event通常是:{仅:{before(){ } ...

回答 1 投票 1

JSDoc嵌套函数无法生成文档

JSDoc嵌套函数无法生成doc。我看到了https://jsdoc.app/tags-mixin.html,这对我不起作用。我不会在我的文档中制作文档。如何为我为decorater Mixin工作?我会...

回答 1 投票 0

从JSDoc生成的消费类型声明:TS7016

我正在使用https://lerna.js.org在一个monorepo中编写一个名为bexer的库,其中包含许多软件包(@ bexer / *)。每个包都包含在JSDoc注释内定义的打字稿类型。任务是...

回答 1 投票 0

如何判断VSCode / TypeScript窗口是否存在服务?

我使用VS Code中的jsCheck设置,它使用TypeScript验证我的代码。有一个全局服务,该服务由后端侧(是,旧版)生成的代码设置,并且被引用为...

回答 1 投票 0

如何将jsDoc与mobx-state-tree一起使用?

我正在尝试将jsDoc用于由mobx-state-tree驱动的应用程序,但它无法按照我想要的方式进行响应。 Visual Studio代码没有向我显示相应类型的正确属性:jsDoc是一个巨大的...

回答 1 投票 0

不确定JSdocs时该如何放置@return

你好,我有一个函数,该函数返回该函数内部的函数结果。因此,我不确定要在@return中放入什么。我正在学习JSdocs,这是我偶然发现的一个问题...

回答 1 投票 1

我如何在Visual Studio Code中对事件使用JSDoc自定义EventEmitter?

我一直在研究Node.js项目,只是注意到Visual Studio Code提供了有关基本EventEmitter对象的信息。所以我想应该有可能为...

回答 1 投票 5

JSDoc用于复用功能接口

我正在连接到多个电子邮件工具,并将其API抽象为一个通用的sendEmail函数,每个服务具有相同的参数和相同的返回值。这意味着对于每个电子邮件服务(...

回答 1 投票 2

JSDoc的输出可以组织成“文件夹”吗?

我正在使用grunt jsdoc从JSDoc注释生成文档,使用默认模板。 在生成的文档中,模块文档的链接都显示在 模块 下的单个列表中。 这个项目使用Reac...

回答 0 投票 7

如何在compodoc中禁用模板选项卡?

我一直在寻找用于angular 2应用程序的doc生成器工具。我发现compodoc对我有用。在此工具的“组件”部分中,我不想生成源代码和模板文件。 -...

回答 1 投票 0

如何为`pipe`d ES6函数生成JSDoc

我有一个ES6样式的函数,该函数是使用asyncPipe的函数组合定义的。从'expo-secure-store'导入{getItemAsync}; const asyncPipe =(... fns)=> x => fns.reduce(异步(y,...

回答 1 投票 6

如何在JSDoc中记录结构化参数?

异步函数userInformation({userId,token}){const body = {user:userId}; const headers = {授权:`bearer $ {token}`,“ Content-Type”:“ application / x-www-form -...

回答 1 投票 0

JSDOC评论格式

我在静态属性获取器内部的聚合物类中具有一个属性,定义如下,并在属性上方对此进行了注释。 / ** *当textElement为空时,textElement( 标签)为...

回答 1 投票 0

如何为使用箭头函数的类方法的parms生成jsdoc?

我是一名学生,他的基本项目/工作综合学习即将结束。我正在制作技术文档,以移交给下一个将继续进行此工作的团队,但是...

回答 1 投票 0

使用JSDoc到文档模块导出类

CommonJS模块中的简单类具有以下JSDoc注释:/ ** *表示项目列表的类。 * * / module.exports =类List {/ ** *创建一个列表。 * / ...

回答 1 投票 0

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