jsdoc 相关问题

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

如何记录泛型类型参数?

假设下面是一个泛型类型,我应该用什么来代替 ???正确记录T? /** * ??? T 的描述。 */ 类我的类 { } 在 C# 中我会使用 。有没有

回答 3 投票 0

如何为 TypeScript 泛型编写 JSDocs?

我正在尝试使用 JSDocs 来获取 isEqual(object1: T, object2: T) 但我收到警告:类型“T”未定义 .eslintjsdoc/no-undefined-types。 我该如何修复这里的 eslint 警告? /*...

回答 0 投票 0

如何使用 JSDoc 记录 useState 挂钩?

我正在尝试使用 JSDoc 来记录我的反应状态挂钩的解构部分,例如: const [referenceState, setReferenceState] = useState(null); 这里,referenceState是Object类型,...

回答 6 投票 0

如何从 JavaScript+JSDoc 中的模块导入类型定义?

我正在尝试将类型定义从 JSDoc 中的模块导入到我的 SvelteKit 应用程序中。 这是我尝试以 JS/JSDoc 形式实现的 TypeScript 代码: 从 '@

回答 1 投票 0

如何记录变量的名称在另一个分类中可以不同?

例如,Discord 和 Messenger 中社区聊天的分类法不同,但它们提供相同的功能: 不和谐 信使 服务器 社区 文字频道/论坛频道 交流...

回答 1 投票 0

如何记录具有多个别名的方法?

我正在尝试记录以下 Person 构造函数的 getName() 方法: JavaScript 代码: /** * 创建一个人实例。 * @param {string} name 该人的全名。 * @构造...

回答 1 投票 0

JSDoc 从另一个文件创建并导入类型

我有一个由 user.model.js 中的某个函数返回的用户对象 常量用户 = { id: "ASwsd122Wqwe1", 姓名:“萨姆”, 电子邮件:“[email protected]”, 创建日期:

回答 1 投票 0

在 JSDoc 中描述对象数组

我有一个接受对象数组的函数。 看起来像这样。 myAwesomeFunction([ { 名称:'某个名称', 下一个:假, 测试一下' }, { 名称:'名称...

回答 2 投票 0

JSDoc @param 与@deprecated

我有一个 JavaScript 函数获取一些参数,包括对象类型。但是,参数的一个属性(即对象)将被弃用。我想指出这个情况...

回答 2 投票 0

如何记录 JavaScript Promise 的解析值

给出这段代码: 函数 asyncFoo() { 返回新的 Promise(函数(履行,拒绝){ doAsyncStuff(函数(错误,数据){ 如果(错误)拒绝(新错误(错误)); 否则满足(新酒吧(d...

回答 4 投票 0

为什么我的函数的参数显示为布尔值(使用 JSDocs),而事实并非如此?

我记录了我对 React 井字棋教程的复制,我不明白为什么我的函数的参数显示为布尔值(使用 JSDocs),而事实并非如此。 这就是

回答 1 投票 0

JSDoc:在另一个@param中引用方法的@param

我是 JSDocs 的新手,找不到这个问题的答案。 假设我想写这个简单的函数: 函数 hasQ(array, item) {return array.includes(item);} 与 JSDoc'...

回答 4 投票 0

如何在 Google 脚本中输入提示 Google Types?

我正在尝试在 Google Script 中输入一堆 javascript,并且我已经尝试了以下操作: /** * 获取由名称给定的(命名)范围 * * @param {String} 名称 * @return {范围} * ...

回答 3 投票 0

如何使用其他模块的类型

VS Code下的JSDoc:如何使用其他模块的类型?在下面的例子中,如何声明 foo(ta)? ma.js (CommonJS) TA 类 {...} module.exports = { makeTA: () => 新 TA, }; mb.js (CommonJS)

回答 1 投票 0

有没有办法将`jsdoc`与`.ts`文件一起使用?也许用 babel 转译然后使用 jsdoc?

有没有办法将 jsdoc 与 typescript 文件一起使用? 我尝试使用 jsdoc-babel 与此配置 { “插件”:[ “node_modules/jsdoc-babel” ], “通天塔”:{ “扩展”:[ “js”, ...

回答 4 投票 0

创建具有特定参数类型的函数

我正在制作一个 Google Apps 脚本函数,它接受两个参数:我创建的电子表格对象和交易对象。我如何指定我希望我的参数具有该类型? 我是

回答 2 投票 0

JSDoc + Mongoose:如何记录 Mongoose 模型?

我有 Mongoose 架构和模型: var MyClientSchema = 新 mongoose.Schema({ 拳名:{ 类型:字符串 }, 电话号码: { 类型:字符串 } }); var MyClient = mongo...

回答 4 投票 0

使用React.fowardRef和useImperativeHandle时如何创建ref的JSDoc?

我没有在我的reactjs项目中使用typescript,但我仍然想用JSDocs来记录我的组件。 问题在于我有一个带有 React.forwardRef 的功能组件,我想...

回答 3 投票 0

JSDoc - 如何记录超类中返回其子类实例的静态方法?

所以我有一个像这样的基类: 类 BaseAPIClass { /** * 异步工厂 * 执行一些异步操作,然后实例化继承类。 * * @param {String} 我...

回答 1 投票 0

JSDoc 来描述 React useState?

如何使用 JSDoc 描述 React 状态? 换句话说,如何将其简化为一句台词? /** 和你在一起的动物 */ 让动物; 让setAnimal; [动物,setAnimal] = useState() ...

回答 1 投票 0

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