请抛弃行内注释,教你如何在typescript中更好的写注释

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第1天,点击查看活动详情

在js/ts中,有两种注释,一种是行内注释,另一种是块级注释。两种虽然都是注释,但是在vscode中的表现是截然不同的,因为vscode引入了jsdoc的支持,所以书写块级注释,能够带来非常好的提示,提高你的开发效率。

块级方法的使用方法是在你声明的变量上面敲一下/** 就会自动出现,然后回车就行了,让我们来看一下实际的效果。

用行内注释和块级注释同时声明一个变量

image.png

我们可以看到,用块级注释是有很好的提示效果的

image.png

image.png

在声明函数的时候更是非常的清晰易懂

image.png

我们可以看到用块级注释声明的函数,在调用的时候非常清楚函数是做什么的?以及参数的含义是什么

image.png

image.png

甚至在声明函数时,里面的参数也能带来很好的提示

image.png

不仅仅是变量,函数。连对象,枚举,接口都能使用块级注释。

image.png

值得一提的是,如果定义对象使用了接口,那么提示是按照接口的注释来的

image.png

如果把接口类型去掉,那么提示才会按照对象的注释来

image.png 不仅如此,注释还能写markdown,没想到把?

image.png

image.png

jsdoc内置了很多类型提示,详情可以查看www.shouce.ren/api/view/a/…

但jsdoc更多的是为js服务的,为了弥补js没有类型提示的缺点,所以有些写法还是过时了。对于ts,就不需要再写参数类型了,我提供我自己的一种写法,仅供大家参考:

image.png

猜你喜欢

转载自juejin.im/post/7128273941650472996