单行上的Visual Studio XML摘要注释

Eug*_*ene 12 comments xml-documentation code-documentation visual-studio

在Visual Studio中,如何将默认的XML摘要注释片段从三行更改为一行?

目前,当我输入时,它会提供以下代码段///:

/// <summary>
/// 
/// </summary>
Run Code Online (Sandbox Code Playgroud)

我想要这个更短的片段:

///<summary></summary>
Run Code Online (Sandbox Code Playgroud)

我的摘要通常很简短,额外的2行是不必要的.

是否有此配置设置或某些可自定义的代码/自定义插件来解决此问题.

Nic*_*ick 6

这是一个较老的问题,但我喜欢 Jason Williams 为此创建一个片段的建议,所以我做了。不是很复杂,但复制和粘贴更容易:)

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>Single line summary</Title>
      <Shortcut>summary</Shortcut>
    </Header>
    <Snippet>
      <Code Language="csharp">
        <![CDATA[/// <summary>$end$</summary>]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>
Run Code Online (Sandbox Code Playgroud)

您可以通过(可能很明显)更改<Shortcut>值来更改快捷方式。

将其粘贴到一个名为的新文件中SingleLineSummary.snippet并将其保存在文件夹中%USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual C#\My Code Snippets(修改以适合您的 Windows 和 Visual Studio 版本)。

如果您不熟悉代码片段,要使用它,只需将光标放在方法/属性/等上方,开始键入summary,然后按 TAB 几次。