.NET模板编译时条件代码被忽略，如何使其正常参与编译？

方法1：在项目文件中配置编译符号 #

打开你的微服务项目.csproj文件，通过添加编译符号让#if EnableSwaggerSupport指令生效：

• 直接固定启用Swagger编译支持：

  <PropertyGroup>
    <!-- 保留原有配置，追加编译符号 -->
    <DefineConstants>$(DefineConstants);EnableSwaggerSupport</DefineConstants>
  </PropertyGroup>
  

• 若要通过模板参数动态控制，可将符号与模板变量绑定（适合dotnet new模板场景）：

  <PropertyGroup>
    <DefineConstants>$(DefineConstants);$(EnableSwaggerSupport)</DefineConstants>
  </PropertyGroup>
  

  生成模板时，只要参数EnableSwaggerSupport为true，编译符号就会被注入，条件内代码会参与编译；参数为false时则不会注入，代码被忽略。

方法2：使用Conditional特性替代预处理器指令 #

给AddSwagger扩展方法添加[Conditional]特性，无需修改项目文件也能实现编译时控制：

public static class SwaggerExtensions
{
    [Conditional("EnableSwaggerSupport")]
    public static IServiceCollection AddSwagger(this IServiceCollection services, IWebHostEnvironment env)
    {
        // Swagger配置逻辑
        return services;
    }
}

当项目定义了EnableSwaggerSupport编译符号时，方法调用会被保留；未定义时，编译器会直接移除调用语句，不影响整体编译。

方法3：模板生成阶段动态替换代码（适合dotnet模板项目） #

如果是创建dotnet new模板，可通过模板引擎实现代码的动态保留/移除：

1. 在模板的.template.config/template.json中添加参数：

   "parameters": [
     {
       "name": "EnableSwaggerSupport",
       "type": "bool",
       "defaultValue": true,
       "description": "是否启用Swagger支持"
     }
   ]
   

2. 在Startup.cs模板文件中使用模板语法：

   #if (EnableSwaggerSupport)
   services.AddSwagger(_environment);
   #endif
   

   生成项目时，模板引擎会根据参数值直接保留或删除这段代码，生成后的项目无需依赖预处理器符号即可正常编译。

关键注意事项 #

• appSettings.json是运行时配置，无法影响编译阶段的预处理器指令，所以这种方式不能让#if内的代码参与编译。
• 若禁用Swagger，需同步条件性移除相关NuGet包依赖，避免冗余：

  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.4.0" Condition="'$(EnableSwaggerSupport)' == 'true'" />
  

内容的提问来源于stack exchange，提问作者Erik Umhoefer