jsdoc 相关问题

@type import('./$types') Comment Syntax 在 SvelteKit 中如何工作？

我目前正在学习 SvelteKit，遇到了一些我不明白其语法的代码。 在 +page.server.ts 我不明白这个语法： /** @type {import('./$types').PageServerLoad} */ 给我的

JSDoc：箭头函数参数

我正在尝试使用 JSDoc（EcmaScript 2015，WebStorm 12 Build 144.3357.8）记录我的代码。 我有一个箭头函数，我想记录它的参数。 这两个例子有效（我得到自动完成...

如何在 JSDoc 中将类型的特定属性作为函数参数类型？

我想将从prisma客户端导入的DocumentType类型的id作为函数参数documentTypeId。如果我通过直接访问 id 来定义它，它就变成了 any 类型。 我怎样才能实现...

JSDoc 快速 js 请求正文的类型提示

如何让 VSCode 的智能感知键入提示请求的正文 (Express.js)？ 例如，我在这里尝试将提示正文键入字符串，但我没有看到任何字符串方法/建议出现： 他……

如何在本地项目中使用jsdoc

目标 我想将 jsdocs 与 npm 一起使用。 背景 我是 npm 及其插件的新手。最近我发现了 jsdoc 并尝试使用它，但没有成功。 我试过的 首先我安装了包...

如何将导出函数标记为在打字稿中某处使用

我有这样的东西： 具有导出功能的模块 一个解析器函数，需要通过别名，如模块名称/函数名称 其他存储库中映射页面和功能的 json 文件...

如何在不导入 NPM/内部模块的情况下使用 JSDoc 类型提示？

通常，当我想在JSDoc中引用一个类但不需要导入它时，我会这样做，这里SimpleLRU是我写的一个实际类： /** @typedef {import("../js/SimpleLRU.js").default}

VSCode 扩展 API：为 JSDoc 中的代码块启用智能感知

我正在尝试将 Intelisense 功能添加到 JSDoc 代码块中，因此它确实包括代码完成并验证这些块内的语法和类型： /** * 确保单词以大写字母

在从另一个实体继承文档的实体中取消 JSdoc 属性

tl；博士 我们可以使用 const myPrecious 从实体继承文档：typeof oldWithJSDoc = ... <- now myPrecious has the same JSDoc. We can also merge or add to an existing documentation, bu...

JSDoc TypeScript 函数的通用类型定义

我在 mjs 中使用 JSDoc 来模拟我拥有的 ts 函数。使用 TypeScript 编译器检查 mjs。来自 ts 文件的原始函数（重载）是这样的： 内联导出函数<

JSDoc - JS 重载函数/方法

我一直在尝试使用 JSDoc 在 JS 中记录一个重载函数： 有 2 个用例： assignSlave(ticket, userid); assignSlave(ticket, firstname, lastname); 我想让它看起来像这样

redux connect隐藏了基本组件的JSDoc。

我有一些组件，我为它写了一些JSDOC。** * random jsdoc * const Test = () => { return; }。现在，无论我在项目中的哪个地方使用这个组件，我都可以看到这个JSDOC（使用......）。

如何用JSDOC记录全局变量的类型？

我有一段在浏览器上运行的代码，有一个从CDN加载的库，把一些变量放在全局范围内。有一个从CDN加载的库，它把一些变量放在全局范围内。我如何记录该变量的类型？例如index....

如何使用JSDocs注释ReactJS状态完整的 "类 "组件道具？

我如何才能在状态完整的 "类 "ReactJS组件注释的道具，以获得自动完成render()内？我尝试了以下内容，但是，它没有工作：导出默认类......。

在sphinx-js中记录一个简单的JavaScript对象。

我有一个使用JSDoc标签记录的对象，** *这个对象的一些描述。* @memberof Constants# * @readonly * @enum {string}。* @property {string} CONST1解释const......。

如何记录只在.call()中使用的函数。

我有两个类，它们初始化了一些值，完全一样的方法，所以我想我可以做一个帮助函数，我可以像这样使用 const a = new ObjectA(); const b = new ObjectB(); function f() {......

JSDocs (更好的文档)'NODE_ENV'不被识别为内部或外部命令、可操作程序或批处理文件。

我试图使用github的官方教程来配置component插件的better-docs，但由于某些原因，我收到了一个奇怪的错误。解析D:\\Projects/train-time/src/stories/...

如何使用 jsdoc 将类型指定为类的实例？

我有一个Example类和一个什么函数，其中第一个参数是example，我如何将某件事情记录下来，使example参数被类型化为Example的实例？ class Example {} ... ...

如何用JSDoc定义一个部分对象（使所有属性都是可选的）。

如何定义一个可以接受对象的部分或全部属性的类型？我知道我可以将每个属性标记为可选的，但是有没有办法让所有的属性都是可选的？ const defaults = { host:...。

@@@@@@@@@@@@@@@@的内部JavaScript文档标记在React代码中，是jsdoc，闭包还是其他？

我注意到React使用@internal标记进行文档编写。哪个程序使用此标签？是jsdoc还是其他？ Google Closure编译器？我在http://usejsdoc.org/ ...