JSDoc 快速上手
SegmentFault
共 1808字,需浏览 4分钟
· 2021-07-10
作者:Midqiu
来源:SegmentFault 思否社区
JSDoc 是在JS代码的注释里,以特定的格式标记变量的类型,函数的参数、返回值等,这样做可以避免调用函数的时候传错或少传参数,提高代码的健壮性,减少bug;再加上编辑器的支持,可以极大的提高编码的效率。
比如说下面的这个例子,
因为我们标记了pd
的类型,当调用pd
这个变量的时候,编辑器可以非常方便的提示这个对象上有什么方法。
我们翻看JSDoc的官方文档发现罗列了一大堆的功能,但其实常用的功能也就几个,只需要花几分钟掌握一下下面的几个使用方法,就可以大幅度提高写代码的编辑体验。
JSDoc语法上要求以/**
开头,*/
的注释。
声明函数的参数
的类型
@param {参数的类型} 参数的名 注释
/**
然后按回车,编辑器会自动替我们补充好相关的变量名等信息,我们只需要填上参数的类型就可以了。类型
除了图上所示的string
之外,还有boolean
、 undefined
、 null
类型;还有复杂类型,{key1:string,key2?:number}
;还可以相互组合比如 string|number
等typescript里面可以用type
定义的。声明函数的返回值
的类型
@returns
来指定函数的参数类型和返回值类型@returns {string}
/**
*
* @param {string} id 注释注释注释
* @param {string} name 注释注释注释
* @returns {string}
*/
function getName(id, name) {
//name.
}
声明变量的类型
/**@type {string} */
var aaa=global.aaa
定义一个类型
类型
,供其他地方使用。@typedef {类型} 类型名
/**@typedef {{name:string,age:number}} User */
/**
* @typedef {Object} User
* @property {string} name
* @property{number} age
*/
定义一个函数类型的复杂类型:
/**@typedef {(a:string,b:string)=>void} FN */
/**@typedef {Function} FN
* @argument {string} a
* @argument {string} b
*/
评论
测试新人,如何快速上手一个陌生的系统!
大家好,我是狂师!作为刚入行不久的测试新人,面对一个陌生的系统时,可能会感到有些手足无措。面对一个全新的系统系统,如何快速上手并展开有效的测试工作是一个重要的挑战。本文将探讨测试新人如何通过一系列步骤和策略,快速熟悉并掌握新系统的测试要点,从而提高测试效率和质量。本文旨在为测试新手提供一份指导,帮助
测试开发技术
0
Spring Boot + flowable 快速实现工作流
关注我们,设为星标,每天7:40不见不散,架构路上与您共享回复架构师获取资源大家好,我是你们的朋友架构君,一个会写代码吟诗的架构师。来源:blog.csdn.net/zhan107876/article/details/120815560总览一、flowable-ui部署运行二、绘制流程图绘图细节:
Java架构师社区
0
2025年有望破万亿,AIoT助力下,物流行业正在迎来快速发展
作者:王飞鹏物联网智库 原创3月底,正在赶赴港股上市的菜鸟网络被阿里总部召回,上市进程按下了暂停键。在阿里去年定下“大拆分”战略后,菜鸟本是最有希望率先独立IPO的企业,但是在临门一脚之际,阿里却做出了不上市的决策。这一举动引发了外界热议。分析人士普遍认为,阿里之所以做出这一决策,很重要的一个原因是
物联网智库
0
10分钟带你上手 Prometheus
原文链接:https://www.cnblogs.com/cjsblog/p/11585145.htmlPrometheus(译:普罗米修斯)用领先的开源监控解决方案为你的指标和警报提供动力(赋能)。 1. 概述1.1. Prometheus是什么?Promethe
DevOps技术栈
1903
Linux服务器大量log日志,如何正确看日志快速定位错误?
针对大量log日志快速定位错误地方动态查看日志tail -f catalina.ou从头打开日志文件cat catalina.ou可以使用 >nanjiangtest.txt 输出某个新日志去查看[root@yesky logs]# cat&n
Java专栏
10
Gin 框架介绍与快速入门
目录Gin 框架介绍与快速入门1.gin.Engine2.gin.Context1.安装2.导入3.第一个Gin 应用1. 快速和轻量级2. 路由和中间件3. JSON解析4. 支持插件5. Gin相关文档一、Gin框架介绍二、基本使用三、应用举例四、Gin 入门核心...
马哥Linux运维
0
《认知觉醒》想要快速成为一个行业的高手,最好的办法就是和行业专...
《认知觉醒》中说:“想要快速成为一个行业的高手,最好的办法就是和行业专家交流,直接向他们请教。 未来学家凯文 凯利的一位朋友想进入一个全新的领域,但是他没有任何经验。于是他就参加该领域内的各种行业会议,...
胖琪的升级之路
0
高端旗舰矩阵完善 骁龙快速细化层级意义几何
时间回到2023年10月,相较于往年,这一年的骁龙峰会来得更早了一些。首先登场的是万众期待的骁龙X Elite,它代表着高通在PC平台领域的野心,出色的能效与端侧AI表现令人印象深刻;其次便是年度旗舰第三代骁龙8平台,...
天极网
0