VS2022保存文件自动加private修饰符致MVVM Toolkit报错求助

问题描述 #

使用Microsoft MVVM Toolkit的[ObservableProperty]特性时，实现属性变更相关的partial方法（如OnNameChanging/OnNameChanged）：

[ObservableProperty]
private string? name;

partial void OnNameChanging(string? value)
{
    Console.WriteLine($"Name is about to change to {value}");
}

partial void OnNameChanged(string? value)
{
    Console.WriteLine($"Name has changed to {value}");
}

VS2022（v17.4.4）会在保存文件时自动给这些partial方法添加private修饰符，触发编译错误：

生成的方法是无实现的partial方法，这意味着如果您选择实现它们，不能指定显式的访问性。即这些方法的实现也应仅声明为partial方法，它们始终隐式具有private访问性。尝试添加显式访问性（例如添加public或private）会导致错误，这在C#中是不允许的。

添加任何访问修饰符或移除partial修饰符都会引发错误。

解决方案 #

方法1：修改VS代码样式规则，禁止自动添加访问修饰符 #

• 打开VS选项：工具 → 选项 → 文本编辑器 → C# → 代码样式 → 常规
• 在"要求显式访问修饰符"区域，找到"方法"对应的设置，将其改为不适用或警告（避免选择"错误"或"建议并自动格式化"）
• 也可以通过项目根目录的.editorconfig文件全局配置，添加以下规则：

  dotnet_style_require_accessibility_modifiers = never:suggestion
  

方法2：给单个partial方法添加格式化排除标记 #

在partial方法前后添加编译指令，阻止VS自动修改：

[ObservableProperty]
private string? name;

#pragma warning disable IDE0040 // 禁止要求显式访问修饰符的规则
partial void OnNameChanging(string? value)
{
    Console.WriteLine($"Name is about to change to {value}");
}

partial void OnNameChanged(string? value)
{
    Console.WriteLine($"Name has changed to {value}");
}
#pragma warning restore IDE0040

方法3：升级Visual Studio版本 #

VS2022 v17.4.4的自动格式化逻辑可能存在对MVVM Toolkit partial方法的识别bug，升级到v17.5及以上版本，该问题大概率已被修复。

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