javascript - 为什么在 JavaScript 注释中使用 '@' - @param

标签 javascript node.js

在 git 上阅读 JavaScript 代码我注意到评论中的单词前经常有 @ 符号 IE @param、@chainable、@return 我在一个回复中阅读了关于 JavaScript 评论的 stackoverflow 问题和回复,其中提到了“支持”的评论词。我不知道发生了什么,或者为什么谷歌看起来是空的。

评论的“支持”字是什么意思?
为什么在“支持”字样前使用@符号?

最佳答案

几个不同的原因......

  • 它使您更容易在评论中将其阅读为“标题”
  • 很容易制作一个解析器,而不会将它们误认为只是在您的评论中使用了“param”一词。
  • 这是 JSDoc 概述的标准
  • 许多其他语言都采用了这种做法。

这只是您将在评论中看到的标准。

关于javascript - 为什么在 JavaScript 注释中使用 '@' - @param,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41373964/

相关文章:

javascript - 如何解决 Angularjs TypeError : Cannot read property 'push' of undefined?

javascript - onChange用下拉标题(不带值)替换img src

node.js - 如何使用 Node JS 创建 Selenium Cucumber html 报告

javascript - Angular 4显示其他组件的弹出窗口onclick

javascript - 如何添加/更改属性的值

node.js - 如何使用网络套接字和 Angular CLI 设置代理

node.js - Postgres 将行的多个返回值插入到表中

javascript - 如何让基于事件发射器的代码在 nodejs 中等待?

javascript - Node 应用程序通过暂停当前执行以交互方式从响应前端获取用户输入

javascript - 在 React 中使用 Dygraph 和 redux?