jsdoc 相关问题

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

JSDoc 两次输出相同的变量

JSDoc 打印所有成员的列表两次。在这些列表中,它还将每个成员打印两次。知道什么可能导致这种行为吗? 这是我的代码: /** @模块样式 */ /** * 继续...

回答 3 投票 0

如何使用@implements

我有一个模型类(在nodejs中),我想从AuthorizationCodeModel实现它。 我希望 WebStorm 检测到我的模型实现了该接口并建议我自动完成 界面。 莫...

回答 2 投票 0

如何在 typescript jsdoc 中引用私有类字段

请告诉我:如何在typescript jsdoc中引用私有类字段? 脚本.js: // @ts-检查 C类{ /** @type { 空 |字符串|数字 } */ #x = 空; // /** @type { ( x : C...

回答 2 投票 0

JSDoc:如何定义一个等于对象属性名称的类型 - 就像 Typescript 的 keyof 一样?

我正在寻找一种使用 JSDoc 获取对象属性名称作为类型的方法。 设一个名为 Record 的对象的 typedef /** * @typedef {{ 日期:字符串, a1:字符串, a2:圣...

回答 2 投票 0

使用@ts-check选项处理空初始化的对象

我在 VScode 中启用了非常有用的 // @ts-check 选项,但现在我不知道如何处理空初始化的对象。 这是一个简化的示例: // @ts-检查 常量设置 = { 答:努...

回答 1 投票 0

JSDoc:重载函数描述放在哪里

鉴于 JSDoc 记录了以下重载函数,我可以在哪里放置该函数的描述? /** * @超载 * @param {字符串} arg0 * @return {无效} *//** * @超载 * @p...

回答 1 投票 0

jsdoc构造函数如何正确返回新对象?

例如我有这样的代码: 导出{创建人} const createPerson = (姓名, 年龄) => { const getFullData = () => { return `人 ${name} 年龄 ${age} 岁` } 返回{...

回答 1 投票 0

VS code 可以自动生成 typescript 类型的 jsdoc 吗?

如果我有这样的功能: const 函数 = (参数: 字符串) => { // ... } 现在在 VS Code 中,如果我开始在上面输入 /** 以便生成文档,它会给出以下内容: /** * * @param para...

回答 1 投票 0

在 JSDoc 中声明 TypeScript 枚举

如何使用 JSDoc @typedefs 在 .js 文件中声明 TypeScript 枚举? (这是一段尚无法迁移到 TypeScript 的遗留代码,但需要导入到 TypeScript

回答 0 投票 0

如何在没有 typescript 的情况下在 vue3 props 上使用 jsdoc?

const props = DefineProps({ 项目: { /** @type {{new(): Color[] }} */ 类型:数组, 要求:真实, }, 选定的颜色:{ 类型:对象, 要求:真实, }, 可组合:{ ...

回答 1 投票 0

JSDoc 与类型映射的交互

我正在寻找有关 TypeScript 的 JSDoc 如何处理类型及其映射和修改的完整信息列表(最好来自“信誉良好的来源”)。 显而易见的基础知识...

回答 1 投票 0

How to document react compound components using JSDoc?

如何正确记录复合组件? 我有这个子组件 /** * 向用户提供帮助文本的 React 组件。 * @typedef 帮助文本 * @type {typeof HelpText} * @param id ...

回答 0 投票 0

在使用 typescript/jsdoc 进行转换时,如何通过属性赋值处理类型转换?

类型 FromType = { // [...] 值:字符串; } 输入 ToType = 省略 & { 值:数字; } 然后 /** * @param {FromType[]} 记录 * @returns {ToType[]} 记录 */

回答 2 投票 0

如何使用 Node.js 在 JSDoc 中将 typedef 从一个文件“导入”到另一个文件?

假设我有一个名为“File1.js”的文件。在这个文件中,我导出了一个对象的对象,我给每个对象一个 typedef,就像这样。 /** * 每个对象的 typedef。 * @typedef {对象} MyObject1 * @

回答 3 投票 0

jsDoc 或任何其他工具的 ES6 项目文档

我有一个由多个文件夹组成的 Nodejs 项目。每个文件夹都旨在成为类的类 java 包。 来源 文件夹A 一个.js ... 文件夹B B.js ... ......

回答 1 投票 0

JSDoc 在 VSCode 的 `exports.default` 上损坏了?

我对 VSCode 和 JSDocs 有非常奇怪的体验。 JSDocs 信息针对命名导出显示,但不针对使用 commonJS 导出方法的默认导出。 问题:世博会上没有信息弹出...

回答 2 投票 0

JSDoc 用于在 Google 表格自动完成下拉列表中显示可选参数

我想记录(在 Google 表格自动完成中)一个带有可选参数的自定义函数,类似于 WEEKDAY 函数(下面的自动完成)。 关于可选参数的 JSDoc 规范没有

回答 2 投票 0

如何在 Typescript 中为对象中的每个键生成元组类型注释

我有一个对象,其中对于对象的每个键,我想创建一个元组,使其具有以下格式 [k, 类型 O[k]] 其中 O 是对象,k 是对象中的键。 例如,考虑...

回答 0 投票 0

如何让 VS Code 识别重写的 JSDoc 以进行重新导出?

在下面的示例中,VS Code 1.77.3 和 TypeScript 5.0.4 似乎没有使用 @deprecated 标签,我不明白为什么?用例是将 lodash 模板函数标记为 depre...

回答 2 投票 0

如何避免jsDoc中的构造函数文档?

我有一个只声明静态方法的类,如 类 Foo { /** * 这个方法什么都不做 */ 静态不做任何事情(){ } } 然而,jsDoc 也为 undecl 生成文档...

回答 0 投票 0

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