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

如图:
image.png

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

阅读 5k
3 个回答

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

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

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

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题