Unity 中使用 Roslyn设计框架和代码规范

参考：

Get started with syntax analysis (Roslyn APIs) | Microsoft Learn

How to fix RS2008 warning? ：https://github.com/dotnet/roslyn-analyzers/issues/5663

AnalysisContext Class (Microsoft.CodeAnalysis.Diagnostics) | Microsoft Learn

https://johnkoerner.com/csharp/navigating-trivia-in-your-diagnostic/

https://johnkoerner.com/csharp/navigating-trivia-in-your-diagnostic/

使用了ECS后，发现Roslyn真是个好工具。对于框架的约束的设计，终于有简单的办法不用人工Review了。

• 一、使用VS开发Analyser框架约束
• 二、开发代码规范
• 三、Roslyn的调试
• 四、在Unity中使用Analyser

一、使用VS 2022开发Analyser框架约束

1、VS中新建类库项目

2、添加NUGET包

安装 Microsoft.CodeAnalysis.CSharp.Workspaces 3.8

3.8 版本号很重要

二、开发代码规范

三、Roslyn的调试

调试参考：JoanComasFdz/dotnet-how-to-debug-source-generator-vs2022: Step by step guide on how to debug a C# SourceGenerator in Visual Studio 2022 (github.com)

1. Add a .NET Standard 2.0 class library for your SourceGenerator.
2. Set the SourceGenerator projet as Startup project.
3. Edit the SourceGenerator project and replace all with:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <Nullable>enable</Nullable>
    <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
    <CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
    <IsRoslynComponent>true</IsRoslynComponent>
    <LangVersion>latest</LangVersion>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.1.0" PrivateAssets="all" />
    <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.3" PrivateAssets="all" />
  </ItemGroup>

  <ItemGroup>
    <None Include="$(OutputPath)\$(AssemblyName).dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
  </ItemGroup>

</Project>

<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> <CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath> <IsRoslynComponent>true</IsRoslynComponent>

上面是关键的三个配置

4. Save it.
5. Add a Console Application project with some examples of code you would like to test the SourceGenerator with.
6. Edit the Console Application porject and add a reference to the SourceGenerator this way:

  <ItemGroup>
    <ProjectReference
      Include="..\MySourceGenerator\MySourceGenerator.csproj"
      OutputItemType="Analyzer"
      ReferenceOutputAssembly="false"/>
  </ItemGroup>

7. Save it.

1. Right click on the SourceGenerator project
2. Click Properties.
3. Click Debug.
4. Click Open debug launch profiles UI.
5. Click on Delete to delete the profile shown.
6. Click on Add
7. Select Roslyn component.
8. In Target project select the Console Application project.
9. Close the UI.
10. Restart Visual Studio 2022.
11. In the debug profiles dropdown next to the Play button, select your SourceGenerator project.
12. Put a break point in your SourceGenerator to make sure the debugger stops.
13. Click Play.

That’s All。

四、Unity使用Analyser

Refer to : https://docs.unity.cn/cn/2022.1/Manual/roslyn-analyzers.html

Of cousrse, there are some Pits you may encounter. Don’t wary, it’s an usual.