visual-studio - 单行的 Visual Studio XML 摘要注释

标签 visual-studio comments xml-documentation code-documentation

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

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

/// <summary>
/// 
/// </summary>

我想要这个较短的片段:
///<summary></summary>

我的摘要通常很简短,多余的 2 行是不必要的。

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

最佳答案

这是一个较老的问题,但我喜欢 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>

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

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

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

关于visual-studio - 单行的 Visual Studio XML 摘要注释,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8278889/

相关文章:

android-studio - Android Studio中的Javadoc @link引用以build.gradle

visual-studio - 打开 vbp Visual Basic 项目

java - Eclipse 2019-09 连接到 Team Foundation Server 无限循环

visual-studio - Typescript 无法在 VS2012 中正确编译

c# - 向 Visual Studio XML 文档添加不同的默认和自定义标记

.net - 使用 Web 部署跳过 XML 文档文件

c# - C#同步接口(interface)和实现注释的方法

c++ - 按 Enter 后如何防止命令行关闭

comments - 使用 pandoc 作为文档生成器

c++ - C/C++ : What does the comment "/*< */" stand for?