Visual Studio中是否有高效方法处理C#代码的重复XML注释？

以下是三种原生支持、无需额外付费工具的高效解决方案：

方案1：使用原生<include>标签抽取公共注释到外部文件 #

C# 原生支持<include>XML注释标签，可以把重复的注释片段统一存到独立的XML文件中，代码中直接引用即可，修改外部文件后所有引用位置的注释都会同步更新，完全不需要改业务代码。

• 步骤1：新建公共注释XML文件，比如CommonComments.xml，存放到解决方案根目录，内容示例：

<?xml version="1.0" encoding="utf-8" ?>
<comments>
    <comment id="param.searchDate">
        <param name="searchDate">用于拉取数据的时间筛选条件</param>
    </comment>
    <comment id="summary.getDataByDate">
        <summary>根据指定搜索日期拉取数据</summary>
    </comment>
</comments>

• 步骤2：在项目中添加该XML文件，将文件属性的「复制到输出目录」设置为「如果较新则复制」
• 步骤3：代码中直接引用对应片段即可：

/// <include file="CommonComments.xml" path='//comment[@id="summary.getDataByDate"]/*' />
/// <include file="CommonComments.xml" path='//comment[@id="param.searchDate"]/*' />
public void MethodX(DateTime searchDate)
{
    var y = MethodY(searchDate);
}

/// <summary>根据指定搜索日期拉取更多数据</summary>
/// <include file="CommonComments.xml" path='//comment[@id="param.searchDate"]/*' />
public void MethodY(DateTime searchDate)
{
    // 业务逻辑
}

该方案完全适配Visual Studio的注释预览、打包生成帮助文档的原生逻辑，适合跨多个不相关类/方法的公共注释统一维护

方案2：使用<inheritdoc>标签复用已有注释 #

如果重复注释的方法存在调用关系、或者继承自同一个接口/基类，可以用<inheritdoc>标签直接复用已有的注释，不需要额外维护外部文件：

/// <summary>根据指定搜索日期拉取数据</summary>
/// <param name="searchDate">用于拉取数据的时间筛选条件</param>
public void MethodX(DateTime searchDate)
{
    var y = MethodY(searchDate);
}

/// <summary>根据指定搜索日期拉取更多数据</summary>
/// <inheritdoc cref="MethodX(DateTime)" path="/param[@name='searchDate']"/>
public void MethodY(DateTime searchDate)
{
    // 业务逻辑
}

该特性在.NET Framework 4.7.2及以上、.NET Core 2.1及以上版本原生支持，低版本可通过安装通用注释增强NuGet包兼容。如果是接口实现、子类继承的场景，直接写<inheritdoc/>即可自动继承父级的所有注释，不需要指定路径

方案3：自定义Visual Studio代码片段（Snippet） #

如果注释改动频率极低，可以把常用的注释片段做成自定义代码片段，输入快捷键即可快速插入，适合不需要后续批量更新的场景：

• 打开Visual Studio → 工具 → 代码片段管理器 → 选择CSharp语言 → 新建自定义snippet文件，把重复的注释片段写进去，设置触发快捷键即可。

内容的提问来源于stack exchange，提问作者Daniël Tulp