C＃源生成器：如何在生成的代码中调试编译器错误？

Question

我正在尝试

但是，从根本上讲，我在生成的代码中调试错误遇到了很大的麻烦。当我在源生成器中的模板中犯了一个错误并尝试编译时，我可能会在生成的文件中遇到“方法必须具有返回类型”之类的错误。但是，当我双击错误时，它不会带我进入生成的代码。这使得很难看到它出了什么问题。

有一个技巧吗？是否有任何方法可以检查生成的代码时无法编译的代码？更一般而言，在生成代码可用于IntelliSense时以及 时的控制权？

我正在使用Visual Studio Professional 2022版本17.1.6和Resharper 2022.1。

提前致谢！

Answer 1

将以下内容添加到您的代码生成器构造函数代码：

#if DEBUG 
    if (!Debugger.IsAttached) 
    { 
        Debugger.Launch(); 
    } 
#endif

现在您可以在Visual Studio中使用断点。

IntelliSense确实是与代码生成器的VS中的垃圾。您需要关闭VS，删除 /bin和 /obj文件夹，重新打开VS，然后重建。每当您进行更改时，都必须完成此操作。 VS将在您更改某些内容后显示旧版本，IntelliSense将标记新事物是错误的，但是它仍然会编译和运行...

为了获得更好的体验，我建议使用Rider，该骑手为代码生成器提供更好的集成体验。

Answer 2

我找到了我问题的部分解决方案。

首先，在使用源发电机时，请勿在Visual Studio 中使用Resharper Builder。它没有提供正确的错误消息。而是从命令行运行dotnet build。您会收到更好的错误消息。

实际上，我的问题的一部分可能是由于我的错误或限制造成的（尽管我没有调查过这一点，所以这是纯粹的猜测）。

其次，您可以在不在编译时间上运行源生成的情况下测试源发电机的内部。。

1. 重构源生成器并提取辅助类别（我们可以称其为 sourceGeneratorHelper.cs ），该类别吸收您的输入（例如XML）并产生输出（例如A StringBuilder ）。
2. 制作一个单独的C＃测试项目 sourceGeneratorHelpertest.csproj 用于测试类 sourceGeneratorHelper.cs 。在此项目中，将您的源生成器项目引用，就好像它是一个常规项目一样 - 即，请勿在您的项目参考中使用outputIteMtype =“ Analyszer”。
3. 现在，您可以单元测试源生成器的内部。您也可以将生成的C＃代码转移到文件中并进行检查。

此外，正如NightOWL888所指出的那样，我可以将其添加到引用项目中，以使其吐出生成的文件到磁盘（
：

<PropertyGroup>
    <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
</PropertyGroup>

我尚未解决Intellisense问题，但是现在我至少可以忍受使用该生成器的工作。