如何让 Visual Studio 显示内置 JavaScript 的内联文档？答案

【问题标题】：How can I make Visual Studio display inline documentation for built-in JavaScript?如何让 Visual Studio 显示内置 JavaScript 的内联文档？
【发布时间】：2013-04-12 07:43:51
【问题描述】：

在 Visual Studio 2010 和 2012 中，JavaScript 编辑器支持显示 JavaScript 事物（例如函数）的内联文档。但是，Visual Studio 似乎没有为 JavaScript 自己的内置部分提供此文档。

这是我想要实现的具体示例。如果我访问String 的charAt 方法，当前发生的情况如下：

对于内置的 .NET 类，Visual Studio 提供了文档。我想为 JavaScript 做同样的事情。

关于如何做到这一点，我认为可以通过提供一个包含使用 JsDoc 或 VsDoc 记录的存根的 JavaScript 文件来完成。然后我可以告诉 Visual Studio 将其用作 IntelliSense 的参考。不幸的是，我找不到任何已经这样做的现有工作。

【问题讨论】：

为了澄清，使用您的示例，您是否正在寻找 charAt 函数的更详细描述，而不仅仅是参数列表？如您的示例所示，当前的 javascript intellisense 似乎列出了上下文相关的方法及其参数。
@GravityWell，是的；这是正确的。具体来说，我想要函数摘要文档和参数文档。

标签： javascript visual-studio-2010 visual-studio-2012 intellisense jsdoc

【解决方案1】：

在 VS2012 中，您可以使用所有 VSDoc 文档创建一个 JavaScript 文件，然后将其保存为参考文件。

要配置参考文件：

从主菜单栏中选择TOOLS > Options
导航到Text Editor > JavaScript > IntelliSense > References
从参考组下拉列表中选择Implicit (Web)
找到您的文件，然后单击Add

【讨论】：

从技术上讲，你是对的。但是我真的不想为 JavaScript 的内置函数输入我自己的文档。我更愿意重用现有的工作。

【解决方案2】：

在VS12中，你需要的magic文件是~/Scripts/_reference.js

像这样放置线条，当然要替换正确的路径。

如果有 jQuery VSDOC，它应该会选择它。

/// <reference path="~/Scripts/Frameworks/Kendo/kendo.web.exploded.js"/>
/// <reference path="~/Scripts/Frameworks/jQuery/jquery.1.8.2.js"/>
/// <reference path="~/Scripts/kendoize/kendoize.js" />
/// <reference path="~/Scripts/kendoize/validation.js" />

【讨论】：

我想你误解了我的意思；问题是关于记录内置 JavaScript 函数和事物。您提供的所有示例似乎都是针对外部库的，我怀疑其中包含此文档。关于问题中的示例，这些文件是否包含String.prototype.charAt 的文档？您提供的信息看起来很有用且有帮助，但我认为这不是合适的地方。