如何使用Roslyn枚举Visual Basic文档成员并获取其名称与起止行号

一、枚举VB文档中的成员 #

要枚举VB文档里的命名空间、类、方法等成员，有两种实用方式：

方式1：直接用DescendantNodes筛选（就是你当前用的思路） #

这种方式简单直接，直接遍历语法树的所有子节点，筛选出你需要的成员类型即可，适合快速实现需求。

方式2：用SyntaxWalker做优雅遍历 #

如果需要处理大量节点或者要针对不同成员做差异化逻辑，SyntaxWalker会更清晰——它能自动帮你遍历指定类型的节点，不用手动写一堆Where条件。比如自定义一个VB成员遍历器：

public class VbMemberWalker : SyntaxWalker
{
    public List<SyntaxNode> Members { get; } = new List<SyntaxNode>();

    public override void VisitNamespaceStatement(NamespaceStatementSyntax node)
    {
        Members.Add(node);
        base.VisitNamespaceStatement(node); // 继续遍历命名空间内部的成员
    }

    public override void VisitClassStatement(ClassStatementSyntax node)
    {
        Members.Add(node);
        base.VisitClassStatement(node);
    }

    // 按需重写其他成员类型的Visit方法
    public override void VisitModuleStatement(ModuleStatementSyntax node)
    {
        Members.Add(node);
        base.VisitModuleStatement(node);
    }

    public override void VisitMethodBase(MethodBaseSyntax node)
    {
        Members.Add(node);
        base.VisitMethodBase(node);
    }
}

使用时只需要：

var walker = new VbMemberWalker();
walker.Visit(syntaxTree.GetRoot());
var members = walker.Members;

二、提取成员的名称、起始/结束行号 #

你已经找对了筛选节点的方向，接下来只需要针对不同节点类型提取对应的信息就行：

1. 获取成员名称 #

不同类型的节点，名称的获取方式略有差异：

• 命名空间：NamespaceStatementSyntax.Name.ToString()
• 类/模块：ClassStatementSyntax.Identifier.Text 或 ModuleStatementSyntax.Identifier.Text
• 方法/函数/构造函数：MethodBaseSyntax.Identifier.Text（Function、SubNew、Sub都继承自MethodBaseSyntax）
• 属性：PropertyStatementSyntax.Identifier.Text
• 对IncompleteMemberSyntax这类可能没有标识符的节点，记得做空值判断

2. 获取起始和结束行号 #

Roslyn的行号是从0开始计数的，而文档里的行号一般从1开始，所以需要加1转换。通过SyntaxTree.GetLineSpan(node.Span)可以拿到节点的行位置信息：

var lineSpan = syntaxTree.GetLineSpan(node.Span);
var startLine = lineSpan.StartLinePosition.Line + 1;
var endLine = lineSpan.EndLinePosition.Line + 1;

完整代码示例 #

结合你现有的代码，修改后可以这样实现：

// 先加载VB文档的语法树
var syntaxTree = VisualBasicSyntaxTree.ParseText(yourVbDocumentContent);
var root = syntaxTree.GetRoot();

// 筛选目标成员节点
var members = root.DescendantNodes()
    .Where(node => node is ClassStatementSyntax 
                || node is FunctionAggregationSyntax 
                || node is IncompleteMemberSyntax 
                || node is MethodBaseSyntax 
                || node is ModuleStatementSyntax 
                || node is NamespaceStatementSyntax 
                || node is PropertyStatementSyntax 
                || node is SubNewStatementSyntax);

// 遍历提取信息
foreach (var member in members)
{
    // 匹配不同节点类型获取名称
    string name = member switch
    {
        NamespaceStatementSyntax ns => ns.Name.ToString(),
        ClassStatementSyntax cls => cls.Identifier.Text,
        ModuleStatementSyntax modu => modu.Identifier.Text,
        MethodBaseSyntax method => method.Identifier.Text,
        PropertyStatementSyntax prop => prop.Identifier.Text,
        IncompleteMemberSyntax incomplete => incomplete.Identifier?.Text ?? "未完成成员",
        FunctionAggregationSyntax agg => agg.Identifier?.Text ?? "聚合函数",
        _ => "未知成员"
    };

    // 获取行号信息
    var lineSpan = syntaxTree.GetLineSpan(member.Span);
    int startLine = lineSpan.StartLinePosition.Line + 1;
    int endLine = lineSpan.EndLinePosition.Line + 1;

    // 输出或处理结果
    Console.WriteLine($"成员类型：{member.GetType().Name}，名称：{name}，起始行：{startLine}，结束行：{endLine}");
}

小提示 #

• 如果你需要更精确的位置（比如列号），可以用lineSpan.StartLinePosition.Character和lineSpan.EndLinePosition.Character来获取。
• 对可能存在空标识符的节点，一定要做空值判断，避免空引用异常。

内容的提问来源于stack exchange，提问作者Joginder S Nahil