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 - 在基于 Ajax 的表单提交上显示不同的消息

angularjs - 我如何以 Angular 动态显示我的 Flash 消息。消息必须来自 API 响应

javascript - 使用 javascript 检查 URL 是否存在

函数的 Javascript 引用错误

python - 尝试从python-shell获取数据,将其解析为nodeJS中的对象

javascript - String.replace with/and\in Nodejs 不同于 Chrome?

node.js - 如何修复和防止 mongodb 中的重复键错误

node.js - node-soap 更改操作的命名空间

javascript - 如何在 select2 多选中预选值?

javascript - 使用 Normalizr 标准化我的嵌套 JSON