Visual Studio XML 注释 snippet 模板

1. 代码片段内容（XML文件）

把下面内容保存成文件，比如 StrongXmlDoc.snippet：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
<CodeSnippet Format="1.0.0">
  <Header>
    <Title>Strong XML Doc</Title>
    <Shortcut>strongdoc</Shortcut>
    <Description>高级的 XML 注释模板，带 param, returns, exception</Description>
    <Author>YourName</Author>
    <SnippetTypes>
      <SnippetType>Expansion</SnippetType>
    </SnippetTypes>
  </Header>
  <Snippet>
    <Declarations>
      <Literal>
        <ID>summary</ID>
        <Default>方法描述</Default>
      </Literal>
      <Literal>
        <ID>param1</ID>
        <Default>参数1说明</Default>
      </Literal>
      <Literal>
        <ID>param2</ID>
        <Default>参数2说明</Default>
      </Literal>
      <Literal>
        <ID>returns</ID>
        <Default>返回值说明</Default>
      </Literal>
      <Literal>
        <ID>exceptionType</ID>
        <Default>Exception类型</Default>
      </Literal>
      <Literal>
        <ID>exceptionDesc</ID>
        <Default>异常说明</Default>
      </Literal>
    </Declarations>
    <Code Language="csharp"><![CDATA[
/// <summary>
/// $summary$
/// </summary>
/// <param name="param1">$param1$</param>
/// <param name="param2">$param2$</param>
/// <returns>$returns$</returns>
/// <exception cref="$exceptionType$">$exceptionDesc$</exception>
]]></Code>
  </Snippet>
</CodeSnippet>
</CodeSnippets>

2. 安装代码片段

1. 在 Visual Studio 顶部菜单，选择：工具 > 代码片段管理器（或者用快捷键 Ctrl+K, Ctrl+B）。

2. 在“语言”下拉选 C#。

3. 点击 导入，选择保存的 StrongXmlDoc.snippet 文件，点击完成。

4. 会看到“Strong XML Doc”出现在片段列表里。

3. 使用方法

• 在方法上方空白行，输入 strongdoc，然后按 Tab 键两次（或者按下回车）即可展开模板。

• 模板里会有占位符（$summary$、$param1$ 等），用 Tab 快速跳转依次填写。

• 可以根据实际参数个数，改写代码片段里的 <param> 部分，添加或删除 <Literal> 标签。

4. 示例效果

输入 strongdoc + Tab，会变成：

/// <summary>
/// 方法描述
/// </summary>
/// <param name="param1">参数1说明</param>
/// <param name="param2">参数2说明</param>
/// <returns>返回值说明</returns>
/// <exception cref="Exception类型">异常说明</exception>

只需修改文字即可。