如何使Visual Studio显示内置JavaScript的内联文档?

时间:2013-04-19 01:18:44

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

在Visual Studio 2010和2012中,JavaScript编辑器支持显示JavaScript等内容的内联文档,例如函数。但是,Visual Studio似乎没有附带此文档用于JavaScript自己的内置部件。

这是我想要实现的具体例子。如果我访问String的{​​{1}}方法,则会发生以下情况:

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

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

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

2 个答案:

答案 0 :(得分:0)

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

配置参考文件:

  1. 从主菜单栏中选择TOOLS > Options
  2. 导航至Text Editor > JavaScript > IntelliSense > References
  3. 从参考组下拉列表
  4. 中选择Implicit (Web)
  5. 找到您的文件,然后点击Add

答案 1 :(得分:-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" />