Visual Studio 2019+能否无需第三方工具修改默认XML注释模板？

适用版本 #

Visual Studio 2019 16.6 及以上所有正式版本、Visual Studio 2022 全版本均可使用，无需安装任何第三方工具。

操作步骤 #

• 第一步：找到对应版本的注释模板配置文件路径：
  • Visual Studio 2019 默认路径（32位程序）：
    C:\Program Files (x86)\Microsoft Visual Studio\2019\<VS版本（Community/Professional/Enterprise）>\VC#\Snippets\<语言ID>\Comment\CSharpComments.snippet
  • Visual Studio 2022 默认路径（64位程序）：
    C:\Program Files\Microsoft Visual Studio\2022\<VS版本（Community/Professional/Enterprise）>\VC#\Snippets\<语言ID>\Comment\CSharpComments.snippet
    注：简体中文环境语言ID为2052，英文环境语言ID为1033。
• 第二步：备份原配置文件后，使用管理员权限打开CSharpComments.snippet文件。
• 第三步：找到需要修改的成员类型对应的模板段，比如要修改方法的注释模板，定位到ID为Method的<Snippet>节点，在<Code>标签的CDATA内容中按需求添加自定义标签即可。
  示例：添加自定义<myTag>标签的修改后代码段如下：

  <Code Language="csharp"><![CDATA[/// <summary>
  /// $end$
  /// </summary>
  /// <param name="$paramName$">$paramDescription$</param>
  /// <myTag></myTag>
  /// <returns>$returnValue$</returns>]]></Code>
  

• 第四步：保存修改后的配置文件，重启Visual Studio即可生效，后续输入///触发自动注释时就会生成包含自定义标签的模板。

注意事项 #

• Visual Studio进行大版本更新时，可能会覆盖默认snippet配置文件，更新后需重新修改配置
• 如仅需对特定项目生效，可将修改后的snippet文件导入到当前项目的自定义代码片段集中即可，无需修改全局配置

内容的提问来源于stack exchange，提问作者DMX David Cardinal