c# - 使用 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 以正确报告诊断，但我找不到用于添加诊断的 Roslyn API Paramater 到 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         
}

如何正确更新方法声明并返回更新后的文档？

Answer 1

@Nate Barbettin 是正确的，语法节点都是不可变的，所以我需要创建一个新版本的 MethodDeclarationSyntax，然后在 document< 中用新方法替换旧方法 的 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);
    }