面试题：C# 静态代码分析中自定义规则的实现

Question

假设你需要在 C# 的静态代码分析中添加一个自定义规则，用于检测所有方法中是否存在未使用的局部变量。请阐述实现这个自定义规则的大致思路，包括涉及到的主要类库和接口，以及如何将自定义规则集成到项目的静态代码分析流程中。

Answer 1

实现思路

1. 解析语法树：利用 Roslyn 编译器平台来解析 C# 代码的语法树，这样可以遍历代码中的各种元素，包括方法和局部变量声明。
2. 遍历方法：在语法树遍历过程中，针对每个方法节点，获取其内部声明的所有局部变量。
3. 检测变量使用：检查每个局部变量是否在后续代码中有使用。可以通过数据流分析等技术，跟踪变量的使用情况。

主要类库和接口

1. Microsoft.CodeAnalysis.CSharp：用于处理 C# 语法相关的操作，如解析 C# 代码为语法树。
2. Microsoft.CodeAnalysis.Diagnostics：包含用于创建诊断分析器（自定义规则）的接口和类。主要接口 DiagnosticAnalyzer 用于定义自定义分析逻辑，DiagnosticDescriptor 用于描述诊断（规则）的元数据，如规则 ID、标题、描述等，Diagnostic 用于表示分析过程中发现的问题。

集成到项目静态代码分析流程

1. 创建分析器项目：在 Visual Studio 中创建一个新的类库项目，目标框架应与项目使用的框架兼容。安装 Microsoft.CodeAnalysis.Analyzers NuGet 包，以便使用 Roslyn 分析器相关功能。
2. 编写分析器代码：创建一个继承自 DiagnosticAnalyzer 的类，在该类中实现 Initialize 方法来注册分析动作。在分析动作中，遍历语法树节点，实现检测未使用局部变量的逻辑，并在发现问题时创建 Diagnostic 对象。
3. 配置分析器：将编写好的分析器项目生成的 DLL 作为 NuGet 包发布（可以是本地 NuGet 源）。然后在目标项目中安装这个 NuGet 包。项目在编译时，就会自动运行分析器，检测到未使用局部变量时，会在 Visual Studio 的错误列表中显示相应的诊断信息。也可以通过命令行工具（如 dotnet build）进行分析，分析结果同样会显示在输出中。