JSDoc 注释规范

在这里插入图片描述

JSDoc 注释

在 前端项目中,注释格式包含了一些特殊标记,如 @param@returns 等,这种注释通常是用来标记函数或方法的参数返回值的数据类型和描述
这种注释格式通常被称为 JSDoc 注释。在实际开发中,这样的注释可以被一些工具解析,以生成代码的文档或者提供代码的自动补全功能。

JSDoc 是一种用于 JavaScript 的文档注释标记语言,它允许开发者使用一种类似于 JavaDoc 和 PHPDoc 的方式来描述
JavaScript
代码中函数、方法、类等的参数、返回值、功能等信息。这样的注释能够帮助开发者更好地理解代码的用法和功能,并且可以通过一些工具生成文档。

以下是一个示例 JSDoc 注释的格式:

/*** 计算两个数字的和** @param {number} a 第一个数字* @param {number} b 第二个数字* @returns {number} 两个数字的和*/
function add(a, b) {return a + b;
}

在这个示例中,@param {number} a 表示 add 函数接受一个数字类型的参数 a@returns {number} 表示 add 函数返回一个数字类型的值。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/460818.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

每日一题!如约而至!(图片整理,寻找数组的中心下标)

今天是腊月二十九&#xff0c;挂灯笼喽&#xff01; 图片整理_牛客题霸_牛客网 (nowcoder.com) #include <stdio.h> #include <string.h>int main() {char str[1001] {\0};while (scanf("%s", str) ! EOF) {//输入的是字符串int len strlen(str);for(…

今日arXiv最热NLP大模型论文:无需数据集,大模型可通过强化学习与实体环境高效对齐 | ICLR2024

引言&#xff1a;将大型语言模型与环境对齐的挑战 虽然大语言模型&#xff08;LLMs&#xff09;在自然语言生成、理解等多项任务中取得了显著成就&#xff0c;但是在面对看起来简单的决策任务时&#xff0c;却常常表现不佳。这个问题的主要原因是大语言模型内嵌的知识与实际环…

【力扣】查找总价格为目标值的两个商品,双指针法

查找总价格为目标值的两个商品原题地址 方法一&#xff1a;双指针 这道题和力扣第一题“两数之和”非常像&#xff0c;区别是这道题已经把数组排好序了&#xff0c;所以不考虑暴力枚举和哈希集合的方法&#xff0c;而是利用单调性&#xff0c;使用双指针求解。 考虑数组 pri…

Android 环境搭建

1、桥接工具安装 网站地址&#xff1a;AndroidDevTools - Android开发工具 Android SDK下载 Android Studio下载 Gradle下载 SDK Tools下载 使用安装包&#xff1a; adb 查看当前链接成功的设备&#xff1a;adb devices 使用adb shell指令来进入到手机的后台&#xff1a;

Redis篇之缓存击穿

一、什么是缓存击穿 1.缓存击穿的定义 缓存击穿&#xff1a;给某一个key设置了过期时间&#xff0c;当key过期的时候。恰好这时间点对这个key有大量的并发请求过来&#xff0c;这些并发的请求可能会瞬间把DB压垮。 2.图片理解 二、那么应该如何解决呢 1.方案一&#xff1a;…

C语言——移除元素(三种方法)

目录 前言 ​一.暴力遍历 二.临时数组 三.双指针法(推荐) 前言 https://leetcode.cn/problems/remove-element/ 这是力扣上的一道简单题&#xff0c;我们可以根据前面所讲的顺序表中的删除来实现&#xff0c;同时还有多种解法&#xff0c;下面将依次讲解 一.暴力遍历 这…

【高阶数据结构】位图布隆过滤器

文章目录 1. 位图1.1什么是位图1.2为什么会有位图1.3 实现位图1.4 位图的应用 2. 布隆过滤器2.1 什么是布隆过滤器2.2 为什么会有布隆过滤器2.3 布隆过滤器的插入2.4 布隆过滤器的查找2.5 布隆过滤器的模拟实现2.6 布隆过滤器的优点2.7 布隆过滤器缺陷 3. 海量数据面试题3.1 哈…

Android开发-之屏幕适配

Android开发-之屏幕适配 前言 Android 系统能发展到今天&#xff0c;离不开其开源性&#xff0c;但是随着越来越多的设备接入 Android 系统&#xff0c;并对 Android 系统进行各种各样的定制&#xff0c;导致长期以来出现了各种碎片化严重的问题。例如&#xff0c;Android 屏…

基于Chrome插件的Chatgpt对话无损导出markdown格式(Typora完美显示)

刚刚提交插件到Chrome插件商店正在审核&#xff0c;想尝试的可以先使用&#xff1a; https://github.com/thisisbaiy/ChatGPT-To-Markdown-google-plugin/tree/main 我将源代码上传至了GitHub&#xff0c;欢迎star, IssueGoogle插件名称为&#xff1a;ChatGPT to MarkDown plus…

STM32输出PWM波控制180°舵机

时间记录&#xff1a;2024/2/8 一、PWM介绍 &#xff08;1&#xff09;脉冲宽度调制 &#xff08;2&#xff09;占空比&#xff1a;高电平时间占整个周期时间的比例 &#xff08;3&#xff09;STM32通过定时器实现PWM时具有两种模式 PWM1模式&#xff1a;向上计数模式下&…

Guava RateLimiter单机实战指南

欢迎来到我的博客&#xff0c;代码的世界里&#xff0c;每一行都是一个故事 Guava RateLimiter单机实战指南 前言maven坐标引入业务实现重要参数和方法关于warmupPeriod实战 前言 想象一下你是一位大厨&#xff0c;正在烹饪美味佳肴。突然之间&#xff0c;前来就餐的人潮如潮水…

如何判断线程池已经执行完所有任务了?

目录 不判断的问题 方法1&#xff1a;isTerminated 缺点分析 扩展&#xff1a;线程池的所有状态 方法2&#xff1a;getCompletedTaskCount 方法说明 优缺点分析 方法3&#xff1a;CountDownLatch&#xff08;推荐&#xff09; 优缺点分析 方法4&#xff1a;CyclicBar…