如何配置仅当公开可见类型或成员未在interface文件定义时显示CS1591

核心配置（.NET 5+ SDK 推荐） #

直接在项目根目录的.editorconfig文件中添加以下规则即可：

# 仅对未在接口中定义的公开成员触发CS1591警告，实现接口的成员自动忽略
dotnet_diagnostic.CS1591.exclude_interface_implementations = true

# 可选：如果同时需要忽略重写基类方法的XML注释警告，可添加下面的配置
dotnet_diagnostic.CS1591.exclude_overridden_methods = true

开启该配置后，所有对应接口中已经存在注释的实现成员不会再触发CS1591警告，只有项目中新增的、未在任何接口中定义的公开类型或成员才会提示缺少XML注释，完全匹配需求。

低版本SDK兼容方案 #

如果你使用的.NET SDK版本低于5.0，不支持上述editorconfig配置，可以用两种方式处理：

• 针对单个实现接口的成员，在成员上方添加抑制特性：

[System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "CS1591:Missing XML comment for publicly visible type or member", Justification = "接口已定义注释")]
public void ImplementMethod()
{
    // 实现逻辑
}

• 显式实现接口：显式实现的成员默认不属于实现类的公开成员列表，天然不会触发CS1591警告。

注意事项 #

需要保证接口本身的XML注释完整，这样IDE在用户调用实现类成员时，会自动关联展示接口上的注释，不会出现调用时注释缺失的问题。

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