Roslyn新手求教：如何获取C#方法的ReturnStatementSyntax返回语句

嘿，作为Roslyn新手，刚上手语法树和符号分析确实容易摸不着头脑，我来一步步帮你搞定这个问题！

首先，你已经拿到了目标方法的ISymbol，接下来的核心思路是：把语义层面的符号（ISymbol）映射回语法层面的方法声明节点（MethodDeclarationSyntax），然后在方法体里查找所有ReturnStatementSyntax节点。

步骤1：从ISymbol获取对应的MethodDeclarationSyntax #

Roslyn里，ISymbol是语义分析后的符号，要拿到它对应的源代码语法节点，我们可以用SymbolFinder工具类，或者通过符号的位置信息定位：

// 假设你已经通过逻辑找到了目标方法的symbol（ISymbol类型）
if (symbol != null)
{
    // 查找该符号对应的所有源代码声明
    var methodDeclarations = SymbolFinder.FindSourceDeclarationsAsync(symbol, solution).Result;
    // 筛选出方法声明节点
    var methodDeclaration = methodDeclarations.OfType<MethodDeclarationSyntax>().FirstOrDefault();
}

或者如果你的符号明确来自某个源代码文件，也可以通过位置直接定位：

if (symbol != null && symbol.Locations.Any() && symbol.Locations.First().SourceTree != null)
{
    var syntaxTree = solution.GetDocument(symbol.Locations.First().SourceTree).GetSyntaxTreeAsync().Result;
    var methodDeclaration = syntaxTree.GetRoot().FindNode(symbol.Locations.First().SourceSpan) as MethodDeclarationSyntax;
}

步骤2：在方法体中查找ReturnStatementSyntax #

拿到MethodDeclarationSyntax后，就可以遍历它的方法体，筛选出所有返回语句了：

if (methodDeclaration?.Body != null)
{
    // 获取方法体内所有的返回语句
    var returnStatements = methodDeclaration.Body.DescendantNodes()
        .OfType<ReturnStatementSyntax>()
        .ToList();

    // 遍历处理每个返回语句
    foreach (var returnStmt in returnStatements)
    {
        // 输出返回语句的完整代码
        Console.WriteLine($"返回语句：{returnStmt.ToFullString()}");
        
        // 如果返回语句带表达式（比如return 123;），可以提取表达式
        if (returnStmt.Expression != null)
        {
            Console.WriteLine("返回表达式：" + returnStmt.Expression.ToFullString());
        }
    }
}

特殊情况处理：表达式体方法 #

如果目标方法是表达式体形式（比如public string GetName() => "Alice";），它没有Body，而是用ExpressionBody，这时候要单独处理：

if (methodDeclaration?.ExpressionBody != null)
{
    // 表达式体方法的返回内容就是这个表达式
    var returnExpression = methodDeclaration.ExpressionBody.Expression;
    Console.WriteLine("表达式体方法的返回表达式：" + returnExpression.ToFullString());
}

整合到你的现有代码里 #

把这些逻辑嵌入到你的Find方法中，完整示例大概是这样：

public List<ReferencedSymbol> Find(string solutionPath, string methodName) 
{ 
    var msWorkspace = MSBuildWorkspace.Create(); 
    var solution = msWorkspace.OpenSolutionAsync(solutionPath).Result; 
    InvocationExpressionSyntax node = null; 
    ISymbol symbol = null;

    // --- 新增的获取返回语句逻辑 ---
    if (symbol != null)
    {
        // 获取方法声明节点
        var methodDeclarations = SymbolFinder.FindSourceDeclarationsAsync(symbol, solution).Result;
        var methodDeclaration = methodDeclarations.OfType<MethodDeclarationSyntax>().FirstOrDefault();

        if (methodDeclaration != null)
        {
            // 处理普通方法体的返回语句
            if (methodDeclaration.Body != null)
            {
                var returnStatements = methodDeclaration.Body.DescendantNodes()
                    .OfType<ReturnStatementSyntax>()
                    .ToList();
                
                // 这里添加你对返回语句的业务处理逻辑
            }

            // 处理表达式体方法
            if (methodDeclaration.ExpressionBody != null)
            {
                var returnExpression = methodDeclaration.ExpressionBody.Expression;
                // 这里处理表达式体的返回内容
            }
        }
    }
    // --- 新增逻辑结束 ---

    // 你的原有业务逻辑...
    return new List<ReferencedSymbol>();
}

一些注意点 #

• 记得处理空值：比如方法是void类型可能没有返回语句，或者方法体为空，这些情况都要加判断避免空引用。
• 异步方法的返回语句处理和普通方法一致，不需要额外区分。
• 如果要找特定的返回语句（比如某个分支里的），可以在DescendantNodes后添加更多筛选条件（比如根据父节点类型判断）。

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