javascript - 评论中@前面的文字的目的是什么

Question

我看过其中包含@some text的评论。这是 express.js 中的一个示例：

/**
 * Create an express application.
 *
 * @return {Function}
 * @api public
 */ 

这些@comments也由 Visual Studio Code 以不同的颜色编码。

@前面评论的目的是什么？

标签： javascriptnode.js

Answer 1

这些是JSDoc注释。它们对于解释函数的作用、它采用什么参数和类型以及它在悬停或使用 IDE 中的函数时输出什么非常有用。

例如，在 VSCode 中，此代码： 将生成此工具提示：