如何使用 JSDoc 注释核心 Node.js 模块以在 IntelliJ 中进行代码提示？

【问题标题】：How to annotate core Node.js modules with JSDoc to have code hinting in IntelliJ?如何使用 JSDoc 注释核心 Node.js 模块以在 IntelliJ 中进行代码提示？
【发布时间】：2014-07-15 14:38:08
【问题描述】：

到目前为止，我需要其中两个，util 和 fs。给定这样的代码：

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

不仅 IntelliJ 将 readFileSync 标记为未解析的函数或方法，而且在我看来，我也缺乏 IDE 提供的最佳功能 - 代码提示。

如何使用 JSDoc 注释核心 Node.js 函数以进行代码提示，并且不会将正确的代码错误地标记为无效？

【问题讨论】：

标签： node.js intellij-idea jsdoc

【解决方案1】：

为什么没有解析核心库？

无效代码的问题是您有“不是 NodeJS 项目”。

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

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

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

为什么没有代码补全？

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

关于类型注解可以看这里，例如：https://groups.google.com/forum/#!topic/scripted-dev/xFtPiBJDO4c

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

【讨论】：