如何用JSDoc注释核心Node.js模块以在IntelliJ中获得代码提示

Question

到目前为止，我需要两个，util和fs。给出如下代码:

var fs = require('fs');
var contents = fs.readFileSync('path/to/file', 'utf8');

不仅IntelliJ将readFileSync标记为未解析的函数或方法，而且我也没有，在我看来，ide给出的最佳函数之一-代码提示。

我如何用JSDoc注释核心Node.js函数以使代码提示而不是正确的代码错误地标记为无效?

Answer 1

为什么核心库不解决?

无效代码的问题是你有"不是NodeJS项目"。

你应该安装NodeJS插件:http://plugins.jetbrains.com/plugin/6098?pr=phpStorm

然后用给定的源代码创建一个新项目。

IntelliJ将自动覆盖元数据和挂钩NodeJS环境和所有的核心模块将被解析。

为什么没有代码完成?

IntelliJ努力确定对象签名，但是一些JS编码技术阻止您的IDE读取签名(它只能在运行时中读取)。

关于类型注释，您可以在这里查看，例如:https://groups.google.com/forum/#!主题/scripted-dev xFtPiBJDO4c

更新:我写了一篇文章，描述如何在IntelliJ IDEA中启用NodeJS的类型提示:http://www.fse.guru/nodejs-autocomplete-in-idea-and-webstorm