问答

为什么在注释前面加@param?

作者:admin 2021-05-06 我要评论

如图: 为什么在注释前面加@param,有没有能细说一下的大神? ### 这是 JSDoc 注释, @param 说明后面的 sheet 是一个参数,参见 JSDoc:@param 。 注明参数之后 ...

在说正事之前,我要推荐一个福利:你还在原价购买阿里云、腾讯云、华为云服务器吗?那太亏啦!来这里,新购、升级、续费都打折,能够为您省60%的钱呢!2核4G企业级云服务器低至69元/年,点击进去看看吧>>>)

如图:
image.png

为什么在注释前面加@param,有没有能细说一下的大神?

###

这是 JSDoc 注释,@param说明后面的 sheet 是一个参数,参见 JSDoc:@param
注明参数之后 IDE 可以在调用函数的时候智能地提示所需参数,参数还可以标注类型和参数说明,给 IDE 更多更准确的提示信息。

###

这是jsdoc之类的文档语法,可以自动生成相应文档。在一些工具中也会自动提示。
它一般用于函数声明注释。

###

@param 是用于标注参数的,参数名、参数类型、参数说明

版权声明:本文转载自网络,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。本站转载出于传播更多优秀技术知识之目的,如有侵权请联系QQ/微信:153890879删除

相关文章
  • 为什么在注释前面加@param?

    为什么在注释前面加@param?

  • linux如何把一个二进制文件相关的so打

    linux如何把一个二进制文件相关的so打

  • web vscode的插件如何获取浏览器信息

    web vscode的插件如何获取浏览器信息

  • 富文本编辑器中粘贴了一段带本地图片的

    富文本编辑器中粘贴了一段带本地图片的

腾讯云代理商
海外云服务器