如何告诉JSDoc一个方法返回一个包含类类型的对象？
JSDoc是一种用于JavaScript代码文档化的标记语言，可以通过注释来描述代码的功能、参数、返回值等信息。如果要告诉JSDoc一个方法返回一个包含类类型的对象，可以使用@returns标记来指定返回值的类型。
以下是一个示例：
/**
* 创建一个包含类类型的对象
* @returns {Object} 返回一个包含类类型的对象
*/
function createObject() {
// 创建对象的逻辑
return new MyClass();
}在上述示例中，@returns标记指定了返回值的类型为Object，表示该方法返回一个包含类类型的对象。你可以根据实际情况将Object替换为具体的类名。
关于JSDoc的更多用法和标记，请参考腾讯云的JSDoc文档：JSDoc - 腾讯云
相关·内容
1回答
我有一个创建Express服务器的Node.js函数。我想说明它返回一个Promise，该Promise解析一个包含Express实例(app)和数字(port)的对象。如果这是一个反模式，那也很高兴知道。
浏览 3提问于2018-08-28得票数 1
回答已采纳
我目前正在处理一个在es6类成为对象之前编写的项目，并为此为其所有类使用一个类创建函数。我正在使用VSCode，并且认为，最好使用一些IntelliSense，这样实例就可以显示它们的方法、参数和返回类型等等，因此我用JSDoc记录了它们。我很快就发现JSDoc允许对预ES6类进行文档化。文档几乎包含了我的问题
浏览 8提问于2022-02-25得票数 0
const child = child_process.spawn(someCommand);在这两行代码中，我的IDE告诉我，child对象的child属性是Readable类型，但在我的一生中，我无法弄清楚如何导入该类型，以便在JSDoc中明确使用它作为参数类型提示： * @param {Readable} stream
*/
浏览 3提问于2021-01-07得票数 0
JSDoc 3的包括以下示例： * The complete Triforce, or one or more components of the Triforce.} objects */我实际上是在创建一个类，它接受一个实现接口MessageQueueConnector的对象，该
浏览 3提问于2014-04-16得票数 6
2回答
reference the object return in data above }})编辑：使用js
浏览 10提问于2020-08-05得票数 8
JetBrains有一篇关于JSDoc注释的旧博客文章，解释了如何将变量类型告知集成开发环境。然而，我似乎仍然找不到一种方法来告诉集成开发环境，在许多jQuery回调中的"this“值是HTMLElements。'input').each(function(){ });};
上面的例子仍然会在IDE中产生一个警告<em
浏览 0提问于2016-05-09得票数 4
如果您查看上的示例，您将看到它们使用了以下describe语法(对于它们的BDD模式)： describe('#indexOf()'#indexOf似乎是一种非常常见的格式(我在OSS代码中见过)，但我以前从未见过有人添加括号。再说一遍，摩卡人对测试的了解当然比我多，所以我必须指出他们使用这种语法是有原因的。所以，我的问题是，有人能告诉我一种资源吗？
是“真
浏览 2提问于2015-12-16得票数 0
回答已采纳
当参数类型可以混合时，如何在JavaScript中使用JSDoc记录方法？/** *
* @param viewable viewable，所以我需要创建这些类型</e
浏览 3提问于2013-05-27得票数 51
回答已采纳
假设我有定义类的javascript代码。它的一个静态方法返回一个用于实例化子实例的类。ParentClass { super(type); };我正在使用eslint eslint-plugin-jsdoc检查代码中的JSDoc注释。我的问题是:记录类型<
浏览 3提问于2020-01-08得票数 1
回答已采纳
/** @type {Base} *///or我有一个函数，它检查t是否是已传递类的实例，如果是已传递类的实例时，它的返回类型应该是派生的。但是在上面的jsdoc中，它的返回类型是'typeof派生的
浏览 1提问于2019-06-29得票数 12
1回答
目前在Dojo (1.10)和ESRI的项目中使用Webstorm。}这很容易解决。只包含了以下JSDoc：
浏览 2提问于2016-04-27得票数 2
回答已采纳
3回答
JSDoc:返回对象结构
、、、、
如何告诉JSDoc返回的对象的结构。return {x: xLocation, y: yLocation};虽然这个解析成功，但生成的文档只是简单地说明： The location of an eventType: Object
我正在开发一个API，需要人们知道他们将得到返回的对象。这在JSDoc中是可能的吗？
浏览 4提问于2015-02-27得票数 200
回答已采纳
1回答
我有一个大型的、结构良好的JavaScript对象，如下所示： * My 'class' begins here.:内部函数实际上是一个构造函数，其嵌套函数是有效的方法，返回的对象实际上是它的哪些部分是“公共”的列表。”，而且根本没有将它们包含在任何输出文件中。这是一个非常好的模式，可以紧
浏览 1提问于2016-08-31得票数 6
1回答
我试图用JSDoc来记录我的代码，但是我想不出如何使它能够识别类继承。下面是一个示例代码： * @classdesc Represents a Layer.SarLayer.prototype = Object.create(Layer.prototype);在创建的JSDoc中，我不认为compute_wi在SARLayer中是一个覆盖层<em
浏览 5提问于2022-11-18得票数 0
回答已采纳
我需要在javascript对象中添加一个函数，在本例中如何添加JSDoc注释？ * @typedef {Object} testObj
* @property {!，因此它的表达式如下所示。Function}并在对象部分中写入参数是否足够，或者是否有其他方法。在上面的testFunction中，我想在JSDoc中显示一个带有参数{Number} a, {number} b, {Object} c的</e
浏览 2提问于2022-05-25得票数 0
回答已采纳
2回答
我正在创建一个流:-现在，我将它作为参数传递给一个函数。在为这个方法编写JSdoc时，我不确定它的类型是什么。那么，谁能告诉我在JSdoc中它的类型是什么？
浏览 3提问于2017-11-07得票数 7
1回答
我想在JSDoc注释中表示一个对象数组，但是在运行lint时，在JSDoc中会出现语法错误。{Object[][]}
有人能告诉我如何用JSDoc注释来写它吗？
浏览 0提问于2017-11-05得票数 0
回答已采纳
我有一个包，其中包含一些Javascript代码以及R代码。我可以使用pkgdown为包中的R文档构建一个由Github托管的网站，方法是正确设置并运行 pkgdown::deploy_to_branch() 我还可以使用JSDoc构建一个本地网站来记录Javascript代码，并将其放在pkgdown使用的docs目录中，其中包含来自其他部分的链接。这在本地工作，但当我使用上面的命令将其部署到Gi
浏览 24提问于2021-05-05得票数 0
1回答
我制作了一个组件，它用特定的AuthContext.Provider来呈现value。我看到的：我想看到<em
浏览 5提问于2022-11-14得票数 0
回答已采纳
我有一个实用程序函数，它从数组中返回一个值。但是，数组显然可以包含任何类型的元素，那么我如何记录返回类型是混合的呢？@return mixed
什么是JSDoc等值？
浏览 0提问于2014-12-08得票数 3
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
