javascript - 评论中有“@something”字样？

Question

评论中的这些“@word”有什么用？

我已经在 J​​avaScript 和其他一些语言中看到了这些。是否有一些标准，或者它是专门针对特定工具的？如果有更多类似的东西，有人可以打开这个更高级的评论过程吗？其次，为什么这个例子以两个星号开头？

例子：

/**
 * Builds an absolute Path for a project, where
 * the files should be stored
 *
 * @param projectDir String
 * @param fileName String (optional)
 * @return {String} absolute Path
 */

Answer 1

它可能看起来只是带有一些预先格式化的约定的美学评论。

但这些注释实际上被开发工具用来提供自动文档生成（如 JSDoc）、语法和类型检查，甚至是获取编译指令（Google Closure minifier）。

两个星号和@something符号都是这些开发工具的约定。

因此，如果您永远不会使用这样的开发工具，那么这种表示法纯粹是审美的。但是，如果您要使用这些工具，那么利用自动化流程将成为您工作流程的一部分。

Answer 2

不，没有标准，但这种文档注释风格最流行的工具之一是JSDoc，它松散地基于 Java 的 JavaDoc 注释。