使用 Roslyn CodeFixProvider 向方法添加参数

Question

我正在写一个 Roslyn Code Analyzer，我想确定 async 方法是否 而不是 采用 CancellationToken 然后建议添加它的代码修复：

 //Before Code Fix:
 public async Task Example(){}

 //After Code Fix
 public async Task Example(CancellationToken token){}

我已通过检查 methodDeclaration.ParameterList.Parameters 连接 DiagnosticAnalyzer 以正确报告诊断，但我找不到用于添加 Paramater 的 Roslyn API ]到CodeFixProvider.

里面的ParameterList

这是我目前得到的：

private async Task<Document> HaveMethodTakeACancellationTokenParameter(
        Document document, SyntaxNode syntaxNode, CancellationToken cancellationToken)
{
    var method = syntaxNode as MethodDeclarationSyntax;

    // what goes here?
    // what I want to do is: 
    // method.ParameterList.Parameters.Add(
          new ParameterSyntax(typeof(CancellationToken));

    //somehow return the Document from method         
}

如何正确更新方法声明和 return 更新后的 Document？

Answer 1

@Nate Barbettini 是正确的，语法节点都是不可变的，所以我需要创建一个新版本的MethodDeclarationSyntax，然后用document中的新方法替换旧方法' s SyntaxTree:

private async Task<Document> HaveMethodTakeACancellationTokenParameter(
        Document document, SyntaxNode syntaxNode, CancellationToken cancellationToken)
    {
        var method = syntaxNode as MethodDeclarationSyntax;

        var updatedMethod = method.AddParameterListParameters(
            SyntaxFactory.Parameter(
                SyntaxFactory.Identifier("cancellationToken"))
                .WithType(SyntaxFactory.ParseTypeName(typeof (CancellationToken).FullName)));

        var syntaxTree = await document.GetSyntaxTreeAsync(cancellationToken);

        var updatedSyntaxTree = 
            syntaxTree.GetRoot().ReplaceNode(method, updatedMethod);

        return document.WithSyntaxRoot(updatedSyntaxTree);
    }

使用 Roslyn CodeFixProvider 向方法添加参数

Add a parameter to a method with a Roslyn CodeFixProvider

c#

code-analysis

roslyn

roslyn-code-analysis