在git上读取javascript代码,我经常注意到在注释中的单词之前有 @符号,即@param,@chainable, @return我在一个答复中阅读了有关JavaScript评论的stackoverflow问题,并回复了"支持"单词以进行评论。我不知道发生了什么,或者为什么,Google似乎很空。
评论的"支持"单词是什么意思?
为什么在"支持"单词之前使用 @符号?
几个不同的原因...
- 它使您在评论中更容易将它们读成"标题"
- 很容易制作解析器而不会误认为它们只是在您的评论中使用" param"一词。
- 这是JSDOC概述的标准
- 这是许多其他语言采用的做法。
这只是您在评论中看到的标准。