首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

JSDoc中的动态@returns,基于@param值

JSDoc中的动态@returns是一种用于描述函数返回值的注释标签。它可以根据@param值的类型和描述来推断函数的返回类型,并提供更加准确和详细的文档。

动态@returns标签的使用方式如下:

代码语言:javascript
复制
/**
 * @param {string} name - 用户名
 * @returns {Promise<string>} - 返回一个Promise对象,包含用户的欢迎消息
 */
async function greetUser(name) {
  return `Hello, ${name}! Welcome to our website.`;
}

在上面的例子中,@param标签指定了name参数的类型为string。而动态@returns标签则指定了函数返回一个Promise对象,并且该Promise对象的值为string类型,即用户的欢迎消息。

动态@returns标签的优势在于它可以根据@param值的类型和描述来自动推断函数的返回类型,避免了手动编写返回类型的繁琐和可能出现的错误。这样可以提高代码的可读性和可维护性。

动态@returns标签的应用场景包括但不限于以下情况:

  1. 异步函数的返回类型推断:当函数返回一个Promise对象时,可以使用动态@returns标签来指定Promise对象的值的类型。
  2. 函数返回多种类型的情况:当函数的返回类型可能是多种类型时,可以使用动态@returns标签来指定返回类型的范围。
  3. 提供更加准确的文档:使用动态@returns标签可以提供更加准确和详细的文档,帮助其他开发人员理解函数的返回值。

对于JSDoc中的动态@returns标签,腾讯云并没有提供特定的产品或者产品介绍链接地址。这是一个通用的JSDoc标签,可以在任何支持JSDoc注释的开发环境中使用。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

JSDoc 初探:代码内文档标记

JSDoc是一种用于为JavaScript代码生成文档工具。它基于标签(tag)形式,通过注释来提取代码类型、描述、参数、返回等信息,生成文档供其他人参考。...在JSDoc,可以使用各种标签来描述代码不同方面,例如:@param:用于描述函数或方法参数类型和含义;@returns:用于描述函数或方法返回类型和含义;@throws:用于描述函数或方法可能抛出异常类型和含义...然后在函数@param标签和@returns标签中使用了这个泛型类型参数,以便更通用地描述参数类型和返回类型。...如果不传入 type 参数,则函数可以通过 if (!type) 进行判断,避免出现未定义错误。使用=标记具有默认参数or可选参数在JSDoc,可以使用 = 符号来标记具有默认参数。...需要注意是,在JSDoc中标记参数具有默认并不会改变函数或方法实际调用方式,你可以只在注释写好标记默认参数,而不写在代码,反之亦然(君子协定)。

9510

不是Typescript用不起,而是JSDoc更有性价比?

但前面提到 TS 固有问题也困扰着开发者们,直到今年几起标志性事件发生,将大家目光拉回 JSDoc,人们惊讶地发现:JSDoc 并没有停留在旧时光。...类型声明定义成 TS 风格,更是支持了在 JSDoc 注释类型声明动态引入并解析 TS 类型能力。...255, blue: 255, alpha: 0.1 }; 当然,对于内建了基于 JSDoc 类型检查工具 IDE,比如以代表性 VSCode 来说,其加持能使类型安全锦上添花;与 JSDoc...表单项很多默认需要硬编码、多点维护 前后端对于同一概念变量或动作命名各异 mock 需要手写,并常与最后实际数据结构不符 TDD缺乏依据,代码难以重构 VSCode 缺乏智能感知和提示 对于以上问题...,理论上如果能基于 AST 等手段当然更好,但如本例 Java 似乎没有特别成熟转换工具,java-parser 等库文档资料又过少。

26610

JSDoc ,一个可替代 TypeScript 方案?

JSDoc不同,这些类型在代码本身结束,并且不受强制执行。 类型推断:TypeScript 可以从其推断类型。这有助于减少显式类型注解,使代码库更简洁。...return dividend/divisor; } 关键字 @param 后面定义一个类型,表示定义函数将接受。...改进通用代码文档: 除了在代码添加必要类型之外,JSDoc还有很多方法可以提高可读性和理解便利性。...* @param {number} a - The first number * @param {number} b - The second number * @returns {Number}...它用于创建到指定URL链接,而 @tutorial 标签用于将用户引导到生成文档相对教程链接。 创建模块:在JSDoc创建模块可以使用文件顶部 @module 标签。

42010

JSDoc支持_TypeScript笔记19

@returns(或@return):描述函数返回 @typedef:描述自定义类型 @callback:描述回调函数 @class(或@constructor):表示该函数应该通过new关键字来调用.../a").x; 注意,这种语法是 TypeScript 特有的(JSDoc 并不支持),而 JSDoc 采用 ES Module 引入语法: // a.js /** * @typedef State...[p2] - 可选参数(JSDoc语法) * @param {string} [p3 = 'test'] - 有默认可选参数(JSDoc语法) */ function fn(p1, p2, p3...具体,会对构造函数this属性访问以及构造函数参数进行检查,并且不允许(不通过new关键字)直接调用构造函数: /** * @constructor * @param {number} data.../** * @template T * @param {{new(): T}} C 要求构造函数C必须返回同一类(或子类)实例 * @returns {T} */ function create

4K10

Angular 工具篇之文档管理

支持快速检索,基于强大 lunr.js 搜索引擎。 支持 JSDoc 高亮,支持 @param, @returns, @link, @ignore 和 @example 标签。...文档注释 comments Compodoc 使用 TypeScript AST 解析器和它内部 API,因此注释必须是合法 JSDoc 注释。...JSDoc Tags 由于 TypeScript 编译器限制 目前 Compodoc 只支持以下 JSDoc 标签: @returns —— 描述返回 @ignore —— 表示标记内容永远不会出现在文档...@param —— 定义一个参数类型和描述 @link —— 定义链接另一个方法、文档或外部链接 @example —— 定义一个示例用法 了解完上述标签,我们来看一个比较完整示例(来源于 ionic-code-documentation...{number} a First number * @param {number} b Second number * @returns The sum of a and b */

1.6K10

【译】不是 TypeScript TypeScript -- JSDoc 超能力

目录 带有JSDoc注释TypeScript 激活检查 内联类型 定义对象 定义函数 导入类型 使用泛型 枚举 typeof 从类扩展 带有 JSDoc 注释 TypeScript 在最优情况下,...} 在上面的例子,我们增加了。这个操作只对 number 是合法,有了这些信息,TypeScript 知道addVAT返回将是 number。...类型有很多很多,比评论几种基本类型更多。结果就是使用 JSDoc 类型可以让你走得很远。...定义对象 除了基本类型,在 JavaScript 还经常使用到复杂类型和对象,这种情况对基于注释类型注释也没有问题: /** * @param {[{ price: number, vat: number...* @returns {void} */ /** * @param {string} url * @param {LoadingCallback} cb */ function loadData

3.1K30

JS规范注释

命令名描述 @param @argument 指定参数名和说明来描述一个函数参数 @returns 描述函数返回 @author 指示代码作者 @deprecated 指示一个函数已经废弃,...这与@see很类似,但{@link}能嵌在注释文本 @fileoverview 这是一个特殊标记。...如果在文件第一个文档块中使用这个标记,则指定该文档块余下部分将用来提供这个文件概述 @class 提供类有关信息,用在构造函数文档 @constructor 明确一个函数是某个类构造函数...私有类和函数不会出现在HTML文档,除非运行JSDoc时提供了–private命令行选项 @final 指示一个是常量值。...要记住JavaScript无法真正保证一个是常量 @ignore JSDoc忽略有这个标记函数 例如: ?

3.3K20

使用JSDoc提高代码可读性

作用 本人使用是 vs code 编辑器,内置了对 jsdoc 各种支持,同时还会根据部分常量,语法来推测出对应类型 可以很方便在编辑器中看到效果,所以下面所有示例都是基于 vscode 来做...type 不过因为其他两个标记中都有类型相关指定,所以就拿 @type 来说明一下 首先,在 JSDoc 是支持所有的基本类型,包括数字、字符串、布尔之类。...当然了,关于函数,还是推荐使用 @param 和 @return 来实现,效果更好一些 扩展复杂类型 上边示例大多是基于基本类型描述,但实际开发过程不会说只有这么些基本类型供你使用。...必然会存在着大量复杂结构类型变量、参数或返回。 关于函数参数,在 JSDoc 两种方式可以描述复杂类型: ?.../** * @param {number} [param] 描述 */ function test (param) { } 同事在文档还提到了关于默认写法,实际上如果你可选参数在参数位已经有了默认处理

1.3K20

Gas 优化:Solidity 使用动态数组

理想情况下,这些数据存储在一个小数值动态数组。 在这篇文章例子,我们研究了在 Solidity 中使用动态数组是否比引用数组或类似解决方案在处理这些小数值时更高效。...基于这个特点,再加上处理引用数组时高gas消耗,让我们考虑使用数值数组。 既然我们可以为固定数组操作提供自己库,同样是否也适用于动态数组呢?...可能动态数组 在 Solidity ,只有 storage 类型有动态数组。memory 类型数组必须有固定长度,并且不允许使用push()来附加元素。...在下面的代码,我们将数组长度在存储在256位(32字节)机器码最高位。...更多动态数组 很明显,有更多可能数值数组。

3.3K30

如何查看jsplumb.jsAPI文档(YUIdoc基本使用)

YUIdoc工具介绍 官方仓库:https://github.com/yui/yuidoc YUIdoc是一个基于模板引擎Handlebars.js 自动化文档工具,可以将javascript...jsdoc风格注释语句转换成静态网站式离线文档,所以你可以通过定制模板来为最终生成文档增加不同主题样式。...jsdoc风格通常都会有IDE插件直接生成(vscode和sublime里肯定是有的,因为我自己天天用),最常见是函数声明注释,YUIdoc可以识别的所有语法可以查看官方提供【YUIdoc支持注释语法...@param {Boolean} [extra=false] Do extra, optional work * @return {Boolean} Returns true on success */...你可以通过-e参数来指定注释文件格式,例如你工程是基于Typescript开发,就可以使用yuidoc .

2K00

为你 JavaScript 项目添加智能提示和类型检查

说起来,JavaScript 作为一门动态弱类型解释型语言,变量声明后可以更改类型,并且类型在运行时才能确定,由此容易产生大量代码运行才能发现错误,相比 Java 等静态类型语言,开发体验上确实差了一截...基于 JSDoc JSDoc 是目前最通用 JavaScript API 文档生成器,根据其语法编写代码注释,可以十分方便地自动生成文档。...基于 TypeScript 类型声明文件 除了使用 JSDoc 提前声明类型,更为激进做法是直接使用微软开发 TypeScript,为整个项目带来完善静态类型检查。...不严格地来说,ts 类型声明文件就像用 TypeScript 语法将 JSDoc 注释重写了一遍并提取到了单独文件。...VSCode 更是将二者作了融合,当你二者混用时候,可以直接在 JSDoc 注释中直接使用 ts 类型声明文件定义 interface 和 class 等。

3.2K20
领券