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

在Visual Studio 2010和2012中，JavaScript编辑器支持为JavaScript等东西显示内联文档，如函数。但是，Visual Studio似乎没有提供这个JavaScript自带内置部件的文档。如何让Visual Studio显示内置JavaScript的内联文档？

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

Visual Studio shows the return and parameter types, but it doesn't show documentation.

对于内置.NET类，Visual Studio提供的文档。我想对JavaScript有同样的东西。

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

来源

2013-04-19 Sam

为了阐明，使用你的例子，你是否在寻找一个charAt函数的更详细的描述，多于一个参数列表？如您的示例所示，当前的javascript intellisense似乎列出了上下文相关的方法及其参数。 – GravityWell

@GravityWell，是的;那就对了。具体来说，我希望函数摘要文档和参数文档。 – Sam

-1

在VS12，神奇的文件你需要的是~/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" />

来源

2013-04-19 08:50:26

我认为你误解了我所问的;问题是关于记录**内置JavaScript函数和事情**。你给出的例子都显示为外部库，我怀疑包含这个文档。关于问题中的例子，这些文件是否包含'String.prototype.charAt'的文档？您提供的信息看起来很有用，也很有帮助，但我不认为这是正确的地方。 – Sam

在VS2012中，您可以创建一个包含所有VSDoc文档的JavaScript文件，然后将其另存为参考文件。从参考小组下拉列表

从主菜单栏中选择TOOLS > Options
导航到Text Editor > JavaScript > IntelliSense > References
选择Implicit (Web)
找到您的文件，然后：

要配置的参考文件点击Add

来源

2013-09-09 12:16:47

从技术上讲，你是对的。但我并不想为JavaScript的内置函数输入自己的文档;我宁愿重新使用现有的工作。 – Sam

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

回答

相关问题