jsdoc 相关问题

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

Eslint Jsdoc插件未执行

我正在运行npx eslint时尝试运行ESLint JSDoc插件。强制执行airbnb规则,但不要求添加JSDoc的jsdoc规则。我想念什么吗?这是一个测试仓库包。...

回答 1 投票 1

JetBrains IDE上的Java语言:类型提示自定义自定义元素实例

请考虑以下内容:类MyCustomElement扩展了HTMLElement {} customElements.define('my-custom-element',MyCustomElement); / ** @type {MyCustomElement} * / const myCustomElement = document ....

回答 1 投票 3

vscode和jsdocs-如何为JavaScript函数使用TS接口或类型

我知道类型或接口可用于智能感知功能参数或内联@type。但是有什么方法可以使用类型/接口来给整个功能或对象提供智能感知...

回答 1 投票 4

如何在Jsdoc上保留源代码文件夹结构

我已经用Jsdoc创建了源代码文档,但是当前所有源代码文件都是奇偶校验的。如下所示。如何在Jsdoc上保留源代码文件夹结构我正在实现...

回答 1 投票 0

JSDoc-为预定义类型的数组定义详细的返回类型

TLDR;我该如何翻译:/ ** @return {(((function(... [*] =))| {})[]} * /转换成自己的@typedef。我正在尝试使用JSDoc在@typedef中正确定义从函数返回的值,而我...

回答 1 投票 0

我可以导出document.js中的类型并将其链接为@param中的引用类型吗?

[我想做的事情看起来像这样:/ ** * @class OrganizationDescriptor * /导出类型OrganizationDescriptor = {| OrganizationId:字符串|};然后当我使用此类型作为参数时,文档...

回答 1 投票 0

[当使用TypeScript通过JSDocs检查JS时,如何声明变量对应于名称空间?

在我的JS代码中,我像这样导入模块:const toolbox = require('../ toolbox')/ ** * @param {toolbox.Hammer} Hammer * /功能useHammer(hammer){let nail = new toolbox .Nail()锤子。ham(...

回答 1 投票 0

JSDoc如何在不创建新typedef的情况下添加成员以进行输入

假设我有一个称为A和B的类型/ ** * @typedef A * @type {object} * @property {String} id这是id A * @property {String}名称这是名称A * @property {字符串} child_id这是id ...

回答 2 投票 1

使用JSDoc中的Typescript中定义的接口

我正在尝试使用allowJs和checkJs在JS代码库上设置TypeScript,我有一个JSDoc,它使用接口作为参数类型:* @param {IPlugin [] | IPlugin}插件插件实例。在...

回答 1 投票 1

Google Closure编译器:类作为函数参数

我不知道如何将类引用作为函数参数发送,以便Google Closure编译器可以在高级模式下正确编译它。在下面的示例中,我向...

回答 1 投票 0

JSDoc Typescript声明:如何隐藏“私有”方法

假设我有一个JavaScript类/ ** * @element my-element * /导出类MyElement扩展了HTMLElement {publicMethod(){} / ** @private * / privateMethod(){}} customElements.define('。 ..

回答 1 投票 1

antlr4 javascript-jsdoc开始与正则表达式liternal之间发生冲突

我已经转换了标准的JavaScript Antlr4语法/词法分析器以支持JSDOC定义。我现在必须处理JSDOC一个衬里,例如/ ** @var {sometype} id * /。词法分析器中的第一个规则是...

回答 1 投票 0

以JSON格式获取JSDoc输出

是否可以通过任何方式配置JSDoc,以使输出为JSON格式而不是通常的HMTL格式?] >>

回答 1 投票 4

JSDoc注释未在绝对路径导入中显示

我正在添加JSDoc函数文档,并且在导入具有绝对页面路径的函数时出现我的文档注释出现问题。 JSDoc函数:/ ** *加两个...

回答 1 投票 1

如何正确导出聚集的javascript类

我正在使用VSCode 1.41.1(2019年11月版)。我在像这样的文件夹中有一些JavaScript类:a.js类A {Constructor(){this.m = 2;导出默认值A; b.js B类{...

回答 1 投票 1

是否可能将带有jsdoc子级的文档或渲染道具用作函数?

我正在尝试使用react渲染模式创建一个包装器组件,但我也想记录通过render / children传递的参数,以便例如获得有用的...

回答 1 投票 1

JSDoc中的文档约束

我有一个功能,它是一个React组件。它创建的元素的位置为:绝对;为了使此属性以可预测的方式工作,父元素应使用...

回答 1 投票 0

如何使用prop-type作为打字稿中的类型定义?

情况:考虑让myTypes常量保持道具类型(写在名为my-component.js的文件中的某处),如下所示:从'react'导入React从'react-native'导入{View} ...] >

回答 2 投票 4

JSDoc忽略内联参数注释

我无法让jsdoc 3.5.5生成用于内嵌注释的文档。请参阅随附的示例:/ ** *我的TestCase类* /类TestCase {nottWorkA(/ **字符串* / str)/ **编号* / {...

回答 1 投票 0

Google Closure不会因类型错误而失败

我正在尝试向接收对象数组的函数编写注释。我希望该对象具有某些必填属性。当我设置内部对象的类型并对其进行检查时,它是...

回答 1 投票 0

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