logo标签列表

为什么在JavaScript注释中使用“@”符号 - @param

javascriptnode.js
3

在查看git上的JavaScript代码时，我经常会注意到在注释中出现@符号，例如@param、@chainable、@return。

我阅读了关于JavaScript注释的stackoverflow问题和回复，在其中一条回复中提到了注释的“支持”单词。我不知道发生了什么，也不知道为什么，谷歌搜索也没什么结果。

所谓“支持”的注释单词是什么意思？
为什么需要在“支持”的单词前使用@符号？

8
-> http://usejsdoc.org/about-getting-started.html - Felix Kling
2
这只是JSDoc中使用的一种符号表示法。它可能受到Java中执行的相同类型事情的启发。 - tadman
-> https://devdocs.io/jsdoc/about-getting-started - Irfan
1个回答
0

有几个不同的原因...

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

这只是您在注释中看到的标准。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接