在 Roslyn 分析语法树时添加条件编译符号的支持

 

我们在代码中会写 #if DEBUG 或者 [Conditional("DEBUG")] 来使用已经定义好的条件编译符号。而定义条件编译符号可以在代码中使用 #define WALTERLV 来实现，也可以通过在项目属性中设置条件编译符号（Conditional Compilation Symbols）来实现。

然而如果我们没有做任何特殊处理，那么使用 Roslyn 分析使用了条件编译符号的源码时，就会无法识别这些源码。

---

如果你不知道条件编译符号是什么或者不知道怎么设置，请参见：

• .NET/C# 项目如何优雅地设置条件编译符号？

 

本文内容

 

我们在使用 Roslyn 分析语法树时，会创建语法树的一个实例。如果使用默认的构造函数，那么就不会识别设置了条件编译符号的语句，如下图：

而实际上构造函数的参数中带有 preprocessorSymbols 参数，即预处理符号。在传入此预处理符号的情况下，Roslyn 就可以识别此符号了：

方法是传入 preprocessorSymbols 参数：

var preprocessorSymbols = new[] {"DEBUG", "TRACE", "WALTERLV", "NETCOREAPP2_1"};
var syntaxTree = CSharpSyntaxTree.ParseText(originalText, new CSharpParseOptions(
    LanguageVersion.Latest, DocumentationMode.None, SourceCodeKind.Regular, preprocessorSymbols)

此后，你可以拿 syntaxTree 做其他事情了：

var compileTypeVisitor = new CompileTypeVisitor();
compileTypeVisitor.Visit(syntaxTree.GetRoot());
Types = compileTypeVisitor.Types.ToList();

当然这段代码你可能编译不通过，因为这是另一篇博客中的源码：

• Roslyn 入门：使用 Roslyn 静态分析现有项目中的代码

本文所用的查看语法树的插件，你可以查看另一篇博客：

• Roslyn 入门：使用 Visual Studio 的语法可视化（Syntax Visualizer）窗格查看和了解代码的语法树

---

我的博客会首发于 https://walterlv.com/，而 CSDN 和博客园仅从其中摘选发布，而且一旦发布了就不再更新。

本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。欢迎转载、使用、重新发布，但务必保留文章署名吕毅（包含链接：https://blog.csdn.net/wpwalter），不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请与我联系。