JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。
如何使用 JSDoc @typedefs 在 .js 文件中声明 TypeScript 枚举？ （这是一段尚无法迁移到 TypeScript 的遗留代码，但需要导入到 TypeScript
如何在没有 typescript 的情况下在 vue3 props 上使用 jsdoc？
const props = DefineProps({ 项目： { /** @type {{new(): Color[] }} */ 类型：数组， 要求：真实， }, 选定的颜色：{ 类型：对象， 要求：真实， }, 可组合：{ ...
我正在寻找有关 TypeScript 的 JSDoc 如何处理类型及其映射和修改的完整信息列表（最好来自“信誉良好的来源”）。 显而易见的基础知识...
How to document react compound components using JSDoc?
如何正确记录复合组件？ 我有这个子组件 /** * 向用户提供帮助文本的 React 组件。 * @typedef 帮助文本 * @type {typeof HelpText} * @param id ...
在使用 typescript/jsdoc 进行转换时，如何通过属性赋值处理类型转换？
类型 FromType = { // [...] 值：字符串； } 输入 ToType = 省略 & { 值：数字； } 然后 /** * @param {FromType[]} 记录 * @returns {ToType[]} 记录 */
如何使用 Node.js 在 JSDoc 中将 typedef 从一个文件“导入”到另一个文件？
假设我有一个名为“File1.js”的文件。在这个文件中，我导出了一个对象的对象，我给每个对象一个 typedef，就像这样。 /** * 每个对象的 typedef。 * @typedef {对象} MyObject1 * @
我有一个由多个文件夹组成的 Nodejs 项目。每个文件夹都旨在成为类的类 java 包。 来源 文件夹A 一个.js ... 文件夹B B.js ... ......
JSDoc 在 VSCode 的 `exports.default` 上损坏了？
我对 VSCode 和 JSDocs 有非常奇怪的体验。 JSDocs 信息针对命名导出显示，但不针对使用 commonJS 导出方法的默认导出。 问题：世博会上没有信息弹出...
JSDoc 用于在 Google 表格自动完成下拉列表中显示可选参数
我想记录（在 Google 表格自动完成中）一个带有可选参数的自定义函数，类似于 WEEKDAY 函数（下面的自动完成）。 关于可选参数的 JSDoc 规范没有
如何在 Typescript 中为对象中的每个键生成元组类型注释
我有一个对象，其中对于对象的每个键，我想创建一个元组，使其具有以下格式 [k, 类型 O[k]] 其中 O 是对象，k 是对象中的键。 例如，考虑...
如何让 VS Code 识别重写的 JSDoc 以进行重新导出？
在下面的示例中，VS Code 1.77.3 和 TypeScript 5.0.4 似乎没有使用 @deprecated 标签，我不明白为什么？用例是将 lodash 模板函数标记为 depre...
我有一个只声明静态方法的类，如 类 Foo { /** * 这个方法什么都不做 */ 静态不做任何事情（）{ } } 然而，jsDoc 也为 undecl 生成文档...
@type import('./$types') Comment Syntax 在 SvelteKit 中如何工作？
我目前正在学习 SvelteKit，遇到了一些我不明白其语法的代码。 在 +page.server.ts 我不明白这个语法： /** @type {import('./$types').PageServerLoad} */ 给我的
我正在尝试使用 JSDoc（EcmaScript 2015，WebStorm 12 Build 144.3357.8）记录我的代码。 我有一个箭头函数，我想记录它的参数。 这两个例子有效（我得到自动完成...
我想将从prisma客户端导入的DocumentType类型的id作为函数参数documentTypeId。如果我通过直接访问 id 来定义它，它就变成了 any 类型。 我怎样才能实现...
如何让 VSCode 的智能感知键入提示请求的正文 (Express.js)？ 例如，我在这里尝试将提示正文键入字符串，但我没有看到任何字符串方法/建议出现： 他……
目标 我想将 jsdocs 与 npm 一起使用。 背景 我是 npm 及其插件的新手。最近我发现了 jsdoc 并尝试使用它，但没有成功。 我试过的 首先我安装了包...
我有这样的东西： 具有导出功能的模块 一个解析器函数，需要通过别名，如模块名称/函数名称 其他存储库中映射页面和功能的 json 文件...
如何在不导入 NPM/内部模块的情况下使用 JSDoc 类型提示？
通常，当我想在JSDoc中引用一个类但不需要导入它时，我会这样做，这里SimpleLRU是我写的一个实际类： /** @typedef {import("../js/SimpleLRU.js").default}
VSCode 扩展 API：为 JSDoc 中的代码块启用智能感知
我正在尝试将 Intelisense 功能添加到 JSDoc 代码块中，因此它确实包括代码完成并验证这些块内的语法和类型： /** * 确保单词以大写字母