C# Директивы препроцессора

Директивы препроцессора указывают компилятору предварительно обработать информацию до начала фактической компиляции.

С помощью этих директив можно управлять тем, как компилятор компилирует файлы или какие части компилировать. К распространённым директивам препроцессора относятся условная компиляция, определения макросов и т. д.

Все директивы препроцессора начинаются с#Они начинаются с #, и в одной строке перед директивой препроцессора могут стоять только пробельные символы.

Директивы препроцессора не являются операторами, поэтому они не заканчиваются точкой с запятой.;конец.

Компилятор C# не имеет отдельного препроцессора; однако директивы обрабатываются так, как если бы он был. В C# директивы препроцессора используются для условной компиляции. В отличие от C и C++, они не используются для создания макросов. Директива препроцессора должна быть единственной директивой в этой строке.

Список директив препроцессора C#

В следующей таблице перечислены директивы препроцессора, доступные в C#:

ДирективаОписание
#defineОпределяет символ, который можно использовать для условной компиляции.
#undefОтменяет определение символа.
#ifНачинает блок условной компиляции; включает блок кода, если символ определён.
#elifЕсли предыдущее#ifили#elifЕсли предыдущее условие не выполнено, а текущее условие выполнено, включает блок кода.
#elseЕсли предыдущее#ifили#elifЕсли условие не выполнено, включает блок кода.
#endifЗавершает блок условной компиляции.
#warningГенерирует предупреждающее сообщение компилятора.
#errorГенерирует сообщение об ошибке компилятора.
#regionПомечает область кода, которую можно свернуть и развернуть в IDE, что упрощает организацию и чтение кода.
#endregionЗавершает область кода.
#lineИзменяет номер строки и имя файла в выходных данных компилятора; это можно использовать для отладки или для кода, созданного инструментами.
#pragmaИспользуется для отправки компилятору специальных инструкций, таких как отключение или восстановление определённых предупреждений.
#nullableУправляет контекстом nullable и аннотациями, позволяя включать или отключать проверки компилятором ссылочных типов, допускающих значение NULL.

Пример

#define DEBUG

#if DEBUG
    Console.WriteLine("Режим отладки");
#elif RELEASE
    Console.WriteLine("Режим релиза");
#else
    Console.WriteLine("Другой режим");
#endif

#warning Это предупреждающее сообщение
#error Это сообщение об ошибке

#region MyRegion
    // Ваш код здесь
#endregion

#line 100 "MyFile.cs"
    // Следующая строка будет указана как строка 100 в MyFile.cs
    Console.WriteLine("Это строка 100");
#line default
    // Нумерация строк возвращается к обычной

#pragma warning disable 414
    private int unusedVariable;
#pragma warning restore 414

#nullable enable
    string? nullableString = null;
#nullable disable

#define и #undef Препроцессор

#defineИспользуется для определения символа (обычно для условной компиляции),#undefИспользуется для отмены определения символа.

#define DEBUG

#undef RELEASE

#define позволяет определить символ так, что при использовании символа как выражения, переданного директиве #if, выражение возвращает true. Его синтаксис следующий:

#define symbol

Следующая программа иллюстрирует это:

Пример

#define PI
using System;
namespace PreprocessorDAppl
{
   class Program
   {
      static void Main(string[] args)
      {
         #if (PI)
            Console.WriteLine("PI определён");
         #else
            Console.WriteLine("PI не определён");
         #endif
         Console.ReadKey();
      }
   }
}

Когда приведенный выше код скомпилирован и выполнен, он выдает следующие результаты:

PI is defined

Условные директивы: #if, #elif, #else и #endif

Вы можете использовать#ifдирективу для создания условной директивы.

Условные директивы используются для проверки, имеет ли символ значение true. Если true, компилятор выполнит#ifкод между этой директивой и следующей.

Синтаксис условных директив:

#if symbol [operator symbol]...

где,symbolимя символа для проверки. Вы также можете использовать true и false или поставить оператор отрицания перед символом.

К распространённым операторам относятся:

  • == (равно)
  • != (не равно)
  • && (И)
  • || (ИЛИ)

Вы также можете использовать круглые скобки для группировки символов и операторов. Условные директивы используются для компиляции кода в отладочных сборках или при компиляции указанной конфигурации. Условная директива, начинающаяся с директивы#if, должна явно заканчиваться#endifИнструкция завершена.

#define DEBUG

#if DEBUG
    Console.WriteLine("Debug mode");
#elif RELEASE
    Console.WriteLine("Release mode");
#else
    Console.WriteLine("Other mode");
#endif

Следующая программа демонстрирует использование условных директив:

Пример

#define DEBUG
#define VC_V10
using System;
public class TestClass
{
   public static void Main()
   {

      #if (DEBUG && !VC_V10)
         Console.WriteLine("DEBUG is defined");
      #elif (!DEBUG && VC_V10)
         Console.WriteLine("VC_V10 определён");
      #elif (DEBUG && VC_V10)
         Console.WriteLine("DEBUG и VC_V10 определены");
      #else
         Console.WriteLine("DEBUG и VC_V10 не определены");
      #endif
      Console.ReadKey();
   }
}

Когда приведенный выше код скомпилирован и выполнен, он выдает следующие результаты:

DEBUG and VC_V10 are defined

#warning и #error

#warning используется для генерации предупреждений компилятора, а #error — для генерации ошибок компилятора.

#warning This is a warning message
#error This is an error message

#region и #endregion

Используется для сворачивания кода, что делает код более читаемым.

#region MyRegion
    // Your code here
#endregion

#line

Используется для изменения номера строки файла и имени файла в выводе компилятора.

#line 100 "MyFile.cs"
    // The next line will be reported as line 100 in MyFile.cs
    Console.WriteLine("This is line 100");
#line default
    // Line numbering returns to normal

#pragma

Используется для отправки компилятору специальных инструкций. Чаще всего применяется для отключения определённых предупреждений.

#pragma warning disable 414
    private int unusedVariable;
#pragma warning restore 414

Замечания по использованию директив препроцессора

  • Улучшение читаемости кода: используйте#regionМожет помочь разделить блоки кода и улучшить организацию кода.
  • Условная компиляция: с помощью#ifТакие директивы позволяют компилировать разный код в средах разработки и эксплуатации, упрощая отладку и выпуск.
  • Предупреждения и ошибки: с помощью#warningи#errorОни могут побуждать разработчиков обращать внимание на определённые проблемы во время компиляции.

Правильно используя эти директивы препроцессора, можно лучше контролировать процесс компиляции кода и повысить гибкость и удобство сопровождения кода.

Другие расширения