JSDoc - 如何在 Eclipse 中检查 JavaScript 类型？

Question

我正在应用JSDoc注释：

/**
 * @param {number} millis
 * @param {function} callback
 * */
function sleep(millis, callback) {
    setTimeout(function() {
        callback();
    }, millis);
}

那么什么工具会告诉下面的行有错误？

sleep('aaa', 'sdsdsd');

JSHint 是否了解 JSDoc 类型注释？如何在 Eclipse 中启用此类支持？

Answer 1

jshint 不知道 jsdoc 注释。不过，您可以考虑使用 eslint 并为其编写一个插件来对函数调用执行类型检查。根据项目的设置方式，您可能最终必须预先解析代码以将注释提取到 eslint 规则将使用的规则文件中。

Answer 2

免责声明，我是 tern.java 的作者。

我建议您安装 tern.java 1.0.0-SNAPSHOT。它提供了使用 JSDoc 注释验证 JavaScript 文件的功能。这是此问题示例的屏幕截图：

如果您需要改进 JSDoc 验证，请在此处创建问题

Answer 3

你可以看看

https://github.com/yarax/typelint

它是一个 EsLint 插件，可以对 JSDoc 注释进行类型检查，此外还支持它自己的扩展以使用 Redux 状态或 Swagger 模式（基本上是任何 JSON 模式）进行类型检查。

它有助于避免从头开始编写复杂的复合类型并使用现有数据。

Answer 4

现在 VsCode 可以轻松做到这一点。有两种方法可以激活 vscode 基于 jsDocs 的类型检查。

在文件顶部评论
1. // @ts-check

    您希望检查它。

要为所有文件激活它，请在项目的根目录下创建一个名为
2. jsconfig.json

    的文件，其中包含以下内容： 

   { "compilerOptions": { "checkJs":true } }

现在享受打字错误吧！