通知 Visual Studio 通过反射调用的代码

Question

上下文：

我工作的环境有很多'magic'方法和字段是通过外部代码的反射来调用或设置的。某些东西可能有一个属性，这意味着它将被设置为非默认值，但 Visual Studio 仍然看不到那个方面，并且 "helpfully" 提供了警告。

由于这些是使用属性和特别命名的方法处理的，理想情况下我想为 VS 提供额外的信息，以便它知道它被调用或设置，而无需我手动抑制每个警告。

我研究过编写 Roslyn 分析器，但据我所知，我只能添加额外的警告，不能修改现有的 warnings/reference 计数。

示例：

[MyCmpGet] private Component comp

"Field is never assigned to and will always have its default value null"

然而，由于注释，该字段是通过反射分配的。

[HarmonyPatch]
class Patch
{
     static void Postfix() {}
}

"Private member is unused"
“0 个参考文献”

然而，由于 class 上的注释以及具有特定名称的方法，该方法是通过反射调用的。

问题：

让 visual studio 知道正在设置这些字段以及正在引用这些方法的最佳方法是什么？最好不需要我对每一个都采取手动操作，并且不向示例代码添加任何额外的内容。

Answer 1

您可以实施 DiagnosticSuppressor 分析器。默认分析器模板应生成一个 nuget 包，您可以将其包含在要禁止显示此警告的所有项目中。

这里是诊断抑制器最基本形式的示例：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;
using System.Collections.Immutable;

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class DiagnosticSuppressorForAssignmentWarnings : DiagnosticSuppressor {
    public SuppressionDescriptor SuppressionDescriptor => new SuppressionDescriptor(
        id: "SPR0001", // Id for this analyzer suppressor (You should come up with a unique name for yours)
        suppressedDiagnosticId: "CS0649", // The warning that we may want to suppress
        justification: "This is ok because it is assigned via reflection");

    public override ImmutableArray<SuppressionDescriptor> SupportedSuppressions
        // You can pass in multiple suppression descriptors to have this suppress multiple types of warnings
        => ImmutableArray.Create(SuppressionDescriptor);

    public override void ReportSuppressions(SuppressionAnalysisContext context) {
        foreach (var diagnostic in context.ReportedDiagnostics) {
            // The parsed syntax tree of the file that this warning comes from
            var syntaxTree = diagnostic.Location.SourceTree;
            // The syntax Node that the warning was reported for
            var nodeWithWarning = syntaxTree.GetRoot().FindNode(diagnostic.Location.SourceSpan);
            // A semantic model that can answer questions like 'does this attribute inherit from this type' etc.
            var semanticModel = context.GetSemanticModel(syntaxTree);

            // You can do additional analysis of the source to ensure this is something 
            // that is semantically safe to suppress (like check for an attribute)

            context.ReportSuppression(Suppression.Create(SuppressionDescriptor, diagnostic));
        }
    }
}

有关如何编写分析器的更多文档，我会查看 this blog post or this 文档

通知 Visual Studio 通过反射调用的代码

Notify Visual Studio of code called through reflection

c#

reflection

visual-studio

roslyn