JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。
如何仅使用 JavaScript / JSDocs 实现具有动态键的对象的类型提示？ （TypeScript 知道索引签名，但这不适用于 TypeScript。） 我想使用 JSDoc 来记录参数...
如何在 Visual Studio 中预览折叠的 JSDoc 注释？
我使用的是 Visual Studio 2022 v17.9.5，并且我有带有 JSDoc 注释的 JavaScript 文件，展开后如下所示： 当我折叠 JSDoc 注释时，它们就变成了一个带有三个点的框......
我有这个用 Typescript Jsdocs 输入的函数： /** * 我的功能描述... * @see {@link ../docs/csrf-issues.md} * @param httpClientRef : AxiosInstance * @return {承诺<...
我正在使用 Visual Studio Code 的 Javascript 类型检查功能。 对于那些不熟悉的人来说，这可以实现推断类型，因此您可以享受在 VS Code 中键入的许多好处，而无需编写类型。
如何将 jsdoc 类型添加到解构变量中？ （VSCode）
所以我有一个带有数据属性的响应对象。 对于本示例，其数据是文本类型。 我想要数据属性，并且我希望 VSCode 能够识别它的类型，以便我可以获得其中的一些
是否可以告诉 jsdoc 在与源代码分开的文件中查找该代码的文档？
我希望内联注释尽可能短，因为我的经验是超过 3 或 4 行的注释往往会被掩盖，从而产生很多不必要的“阅读手册...
使用 @component 生成 React 18 项目的 JSDoc 文档
我正在尝试为 React 18 项目设置带有更好文档的 JSDoc，以便我可以使用 @component 装饰器来记录我的组件。 当我尝试安装 better-docs 时，出现以下错误： npm ...
以下是界面。 /** * @界面 */ 类 ISomething { /** * @return {数字} */ 静态 aMethod() { 抛出新的错误（'未实现'）； } /** * @type {Object}...
我有一个函数，它接受两个参数，例如： 函数示例（类型，val）{ // 根据“type”处理“val” } val 可接受的类型取决于类型。 ...
jsdoc 应该在 javascript 中的类或构造函数之前吗？
我使用的是 VScode（但在任何代码编辑器中都应该是相同的），在下面的代码中，当我将鼠标悬停在 Circle 上时，它会显示我编写的 jsdoc 的内容，但不会显示当我
我正在开发一个 JavaScript 类并使用 JSDoc 来获取文档。在构造函数中，我有一个参数mutationAlgorithm，它应该接受来自Mutation类的函数（例如，Mutation.i...
我目前正在使用 JSDoc 将项目从 TypeScript 转换为 JavaScript。我正在尝试使用 JSDoc 执行以下操作： 声明全局{ 命名空间玩笑 { 接口匹配器 { ...
常量伴侣 = { title: '备忘录或消息', 组件：备忘录或消息， 标签：['自动文档']， } 满足 Meta； 我目前正在使用 autodocs 来生成文档，wh...
如何为 TS 类型声明禁用 eslint `require-jsdoc`，或者至少为单个 props
我们喜欢 eslint 规则 require-jsdoc... 大多数时候。但是每当我们导出 TS 类型（或接口）时，如果我们不仅在类型本身上而且在每个类型上都没有 jsdoc 块，我们就会收到警告...
JSDoc globalThis & Window 对象扩展
我正在与 JSDoc 作斗争，试图使其与窗口对象上的新属性一起使用。 我已经尝试了您在代码片段中看到的 Window 和 globalThis 解决方案中的 @typedef，但没有...
在我的 Node.js 项目中，我有正常的类定义，例如： /** * 我很棒的课程。 * @构造函数 */ var MyClass = 函数 MyClass() {} 在另一个文件中我需要它，例如： var 我的类 =
我一直很难让 @borrows 标签在 JSDoc 中工作。我一直在尝试从一个函数获取文档，并将其用作第二个函数的文档。但我不...
所以我最近开始更多地记录我的代码，因为我没有独自完成许多项目。在 VSCode 内的标准 Nodejs 项目中，我可以像这样创建内联 @typedef 和 @type...
如何在 JavaScript/VSCode/TypeScript 中声明 setter 的类型？
我有一个非常简单的例子来演示这个问题： 类人{ _name = ''; _年龄=0； 获取名称（）{ 返回这个._name； } /** * @类型{字符串} */ 设置...
我有以下代码片段，我的问题是如何保留knowLiteral的文字类型信息，而不必像我现在所做的那样拼写出类型？ // @ts-检查 /** * @类型...