jsdoc 相关问题

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

是否可以告诉 jsdoc 在与源代码分开的文件中查找该代码的文档?

我希望内联注释尽可能短,因为我的经验是超过 3 或 4 行的注释往往会被掩盖,从而产生很多不必要的“阅读手册...

回答 3 投票 0

使用 @component 生成 React 18 项目的 JSDoc 文档

我正在尝试为 React 18 项目设置带有更好文档的 JSDoc,以便我可以使用 @component 装饰器来记录我的组件。 当我尝试安装 better-docs 时,出现以下错误: npm ...

回答 1 投票 0

我怎样才能拥有一个带有静态属性和方法的 JSDoc 接口?

以下是界面。 /** * @界面 */ 类 ISomething { /** * @return {数字} */ 静态 aMethod() { 抛出新的错误('未实现'); } /** * @type {Object}...

回答 1 投票 0

JSDoc:用相互依赖的参数记录函数

我有一个函数,它接受两个参数,例如: 函数示例(类型,val){ // 根据“type”处理“val” } val 可接受的类型取决于类型。 ...

回答 1 投票 0

jsdoc 应该在 javascript 中的类或构造函数之前吗?

我使用的是 VScode(但在任何代码编辑器中都应该是相同的),在下面的代码中,当我将鼠标悬停在 Circle 上时,它会显示我编写的 jsdoc 的内容,但不会显示当我

回答 1 投票 0

如何在 JSDoc 中将参数指定为特定类的函数?

我正在开发一个 JavaScript 类并使用 JSDoc 来获取文档。在构造函数中,我有一个参数mutationAlgorithm,它应该接受来自Mutation类的函数(例如,Mutation.i...

回答 1 投票 0

TypeScript 到 JSDoc:全局/接口

我目前正在使用 JSDoc 将项目从 TypeScript 转换为 JavaScript。我正在尝试使用 JSDoc 执行以下操作: 声明全局{ 命名空间玩笑 { 接口匹配器 { ...

回答 2 投票 0

如何在storybook中自动显示ts类型定义

常量伴侣 = { title: '备忘录或消息', 组件:备忘录或消息, 标签:['自动文档'], } 满足 Meta; 我目前正在使用 autodocs 来生成文档,wh...

回答 1 投票 0

如何为 TS 类型声明禁用 eslint `require-jsdoc`,或者至少为单个 props

我们喜欢 eslint 规则 require-jsdoc... 大多数时候。但是每当我们导出 TS 类型(或接口)时,如果我们不仅在类型本身上而且在每个类型上都没有 jsdoc 块,我们就会收到警告...

回答 1 投票 0

JSDoc globalThis & Window 对象扩展

我正在与 JSDoc 作斗争,试图使其与窗口对象上的新属性一起使用。 我已经尝试了您在代码片段中看到的 Window 和 globalThis 解决方案中的 @typedef,但没有...

回答 1 投票 0

JSDoc:Node.js require 语句替换类定义

在我的 Node.js 项目中,我有正常的类定义,例如: /** * 我很棒的课程。 * @构造函数 */ var MyClass = 函数 MyClass() {} 在另一个文件中我需要它,例如: var 我的类 =

回答 1 投票 0

如何在 JSDoc 中使用 @borrows 标签

我一直很难让 @borrows 标签在 JSDoc 中工作。我一直在尝试从一个函数获取文档,并将其用作第二个函数的文档。但我不...

回答 3 投票 0

如何让 JSDoc @typedef 和 @type 显示在 Visual Studio 2022 或 Visual Studio Code 中 ASP.NET Core MVC 项目的 Intellisense 中?

所以我最近开始更多地记录我的代码,因为我没有独自完成许多项目。在 VSCode 内的标准 Nodejs 项目中,我可以像这样创建内联 @typedef 和 @type...

回答 1 投票 0

如何在 JavaScript/VSCode/TypeScript 中声明 setter 的类型?

我有一个非常简单的例子来演示这个问题: 类人{ _name = ''; _年龄=0; 获取名称(){ 返回这个._name; } /** * @类型{字符串} */ 设置...

回答 4 投票 0

如何保持文字类型信息有效?

我有以下代码片段,我的问题是如何保留knowLiteral的文字类型信息,而不必像我现在所做的那样拼写出类型? // @ts-检查 /** * @类型...

回答 1 投票 0

Enum 作为 JSDoc 中的 @param 类型

是否可以使用枚举作为 JSDoc @param 类型声明,如下例所示? /** * @enum { 数字 } */ 常量类型 = { 类型_A:1, 类型_B:2 } /** * @param { 类型 ...

回答 6 投票 0

转发源为变量的对象成员的 JSDoc

我有一个用 JSDoc 记录的函数,然后它成为对象文字的一部分。 我怎样才能将函数的文档转发到对象文字,从而使其可供前任使用......

回答 1 投票 0

从自定义 cypress 命令获取 jsdoc 和 intellisense

我目前正在为我的项目设置 cypress,并认为创建一堆命令以使测试更具可读性是一个好主意。 所以我在 support/commands.js 中添加了这个 柏树。

回答 3 投票 0

将参数传递给超类时出现打字稿错误。 `扩展参数必须具有元组类型或传递给剩余参数 (TS2556)。`

以下错误TS2556,如何修复? 类测试{ 构造函数(x:数字){} } 类 Test2 扩展测试 { 构造函数(...args){ 超级(...参数); // TS2556 } } 或者...

回答 1 投票 0

“复制”源为变量的对象成员的 JSDoc

我有一个用 JSDoc 记录的函数,然后我通过对象文字导出该函数(因为该函数需要在初始化时传入模块级数据)。 我如何转发文档...

回答 1 投票 0

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