如何在Visual Studio 2019中从类提取含类及成员全部XMLDOC注释的接口

方法1：配置Visual Studio 2019原生提取接口功能自动复制XML注释 #

VS2019 16.10及以上版本已经内置了提取接口时复制XML注释的开关，配置步骤如下：

• 打开VS2019，点击顶部菜单栏 工具 -> 选项
• 在左侧导航栏找到 文本编辑器 -> C# -> 高级
• 下拉找到 重构 分组，勾选 提取接口时包含XML文档注释 选项，点击确定保存
• 回到你的User类代码编辑界面，右键点击类名 -> 选择 快速操作和重构 -> 选择 提取接口
• 在弹出的配置框中选择你要提取到接口的成员（这里勾选AddUser方法），点击确定

生成的接口会自动带上原成员的XML注释，效果如下：

/// <summary>
/// 用户操作相关接口
/// </summary>
public interface IUser
{
    /// <summary>
    /// Create user in DB
    /// </summary>
    /// <param name="user"></param>
    void AddUser(User user);
}

对应的User类会自动实现该接口：

public class User : IUser
{
    /// <summary>
    /// Create user in DB
    /// </summary>
    /// <param name="user"></param>
    public void AddUser(User user)
    {
        // Create User
    }
}

方法2：低版本VS2019手动实现方案 #

如果你使用的VS2019版本低于16.10，没有内置上述功能，可以按以下步骤操作：

• 手动创建接口IUser，先复制原类的所有XML注释到接口定义处
• 复制原类中需要提取的方法、属性签名到接口中，对应复制每个成员的XML注释
• 让原User类实现你创建的IUser接口即可

提示：如果后续需要同步接口和实现类的注释修改，可以用inheritdoc标签减少重复维护，在实现类的成员注释处写/// <inheritdoc/>即可自动继承接口对应成员的XML注释，不需要两边重复修改。

内容的提问来源于stack exchange，提问作者Milad Ahmadi