在 Visual Studio 中注释 javascript 方法

Posted 2023-02-21

【中文标题】在 Visual Studio 中注释 javascript 方法

【英文标题】：Comment javascript methods in Visual Studio

【发布时间】：2012-09-11 10:41:48

【问题描述】：

有没有办法在 Visual Studio 2010 的 javascript 中使用自动生成的参数为 XML cmets 插入 sn-p？

如果我在这里输入///...

function foo(a, b)

...它应该变成这个（取决于参数）：

function foo(a, b)
    /// <summary>$cursorhere</summary>
    /// <param name="a" type="string">Param a</param>
    /// <param name="b" type="string">Param b</param>
    /// <returns type="function">Return function</returns>

所以如果我在 C# 代码中，它将类似于 sn-p 生成。

编辑

为了澄清，我只想知道是否有快捷方式或现有插件可以实现上述功能大约。

【问题讨论】：

您如何期望它知道a 和b 是字符串？另外，你怎么知道它返回了什么？

是的，我不知道，没错。但我会默认使用这些参数。 VS 可以通过项目中现有的函数调用来确定对象类型，但这只是一个想法。我想要实现的主要目标是只需键入一些字母并创建摘要（带有参数数量）。

有一种方法我敢肯定，Visual Studio 2010 支持插件，你试过什么？你看过这个：msdn.microsoft.com/en-us/library/ms165392.aspx？

“而且 VS 可以通过项目中现有的函数调用来确定对象类型” - 或者它可能猜测， 因为相同的函数可以被不同的类型调用...

各位，感谢您抽出宝贵时间，我只是在寻找一种简单的方法来添加类似于 C# cmets 的 javascript cmets，我不想编写自己的 插件为此，如果有多个函数调用，它当然必须猜测变量类型，但这根本没有必要。我尝试了什么？只是谷歌搜索，找不到任何东西。我希望在这里得到一个答案，比如“只需按 A，B 然后 C”或“不可能”。

【参考方案1】：

我认为您正在寻找 JS 智能感知 cmets 和参考资料，如下所述：

http://msdn.microsoft.com/en-us/library/bb514138.aspx

基本上它与您的预期非常相似。

更新：抱歉，没有正确阅读您的问题。为自己制作片段很简单，它甚至不是一个插件，只是一个添加到文件系统的 xml 文件。您可以使用 sn-p 编辑器：http://snippeteditor.codeplex.com/ 使其更容易。

【参考方案2】：

您可以编写一个代码 sn-p，但这对我来说似乎太麻烦了。我使用JScript vsdoc Stub Generator，它会生成类似这些的 XML cmets：

此扩展的目标是提供一种将 vsdocs 添加到 JavaScript 的简单方法，该方法的作用类似于 Visual Studio 提供的其他 XML cmets。当在新行上添加三斜杠（“///”）时，会创建注释存根。

【讨论】：

VS 2012 版本也可用here。

2012版在这里visualstudiogallery.msdn.microsoft.com/…

后一个版本（适用于VS2012、VS2013、VS2014）仅适用于Visual Studio Pro 不 Visual Studio Express :(

@WetNoodles，可以访问扩展，Typescript 和 Apache Cordoba 支持它看起来很有希望。今晚试试。

@DimitryK 好的，是的，我刚刚确认这可行。社区本质上是 Express 的下一个版本。