Освоение директив препроцессора C#: практическое руководство

Директивы препроцессора в C#: подробное руководство

Узнайте, как директивы препроцессора C# влияют на компиляцию, управление потоком и обработку ошибок. Руководство охватывает каждую директиву, её синтаксис, реальные примеры и лучшие практики.

Директивы препроцессора — это команды, которые компилятор оценивает перед началом фактической компиляции. Они определяют, какие разделы кода включать, как обрабатывать предупреждения и ошибки, и могут даже изменять представление компилятора о номерах строк и именах файлов.

В C# директива начинается с символа # и занимает одну строку, завершается переводом строки, а не точкой с запятой.

#if expression code #endif

#if expr1 code1 #elif expr2 code2 #endif

#if expr1 code1 #else code2 #endif

#if expr code #endif

#define SYMBOL

#undef SYMBOL

#warning Ваше сообщение

#error Ваше сообщение

#line 50 "FakeProgram.cs" #endif

#region Description code #endregion

#pragma warning disable #endif

Определение и отмена символов

• #define создает символ, который оценивается как true в блоках #if.
• #undef удаляет символ, делая его false.

Пример: определение символа

#define TESTING

Пример: отмена символа

#undef TESTING

Условная компиляция с #if, #elif, #else и #endif

• #if проверяет выражение; код внутри компилируется только если выражение истинно.
• Выражения могут использовать логические операторы (&&, ||, !) и символы.
• #elif позволяет проверять несколько условий последовательно.
• #else выполняется, когда ни одно из предыдущих условий не выполнено.
• #endif закрывает условный блок.

Практический пример

#define CSHARP
#undef PYTHON
using System;
namespace Directive {
    class ConditionalDirective {
        static void Main(string[] args) {
            #if (CSHARP && PYTHON)
            Console.WriteLine("CSHARP и PYTHON определены");
            #elif (CSHARP && !PYTHON)
            Console.WriteLine("CSHARP определен, PYTHON не определен");
            #elif (!CSHARP && PYTHON)
            Console.WriteLine("PYTHON определен, CSHARP не определен");
            #else
            Console.WriteLine("CSHARP и PYTHON не определены");
            #endif
        }
    }
}

Результат: CSHARP определен, PYTHON не определен

Генерация предупреждений и ошибок

• #warning выдает пользовательское предупреждение компилятора, но позволяет программе продолжить.
• #error выдает фатальную ошибку, останавливая компиляцию.

Пример предупреждения

using System;
namespace Directives {
    class WarningDirective {
        public static void Main(string[] args) {
            #if (!CSHARP)
            #warning CSHARP не определен
            #endif
            Console.WriteLine("Пример #warning");
        }
    }
}

Результат включает строку предупреждения, но текст в консоли печатается.

Пример ошибки

using System;
namespace Directive {
    class Error {
        public static void Main(string[] args) {
            #if (!CSHARP)
            #error CSHARP не определен
            #endif
            Console.WriteLine("Пример #error");
        }
    }
}

Результат: сборка завершается ошибкой компиляции; финальная строка консоли никогда не выполняется.

Настройка диагностических позиций с #line

• Изменяет сообщаемый номер строки и имя файла для последующих предупреждений или ошибок.

Пример

using System;
namespace Directive {
    class LineDemo {
        public static void Main(string[] args) {
            #line 200 "AnotherProgram.cs"
            #warning Реальное предупреждение сгенерировано Program.cs на строке 10
        }
    }
}

Результат: Предупреждение появляется как AnotherProgram.cs(200,22): warning CS1030: ...

Организация кода с #region и #endregion

• Группирует связанные блоки кода, которые можно сворачивать в редакторах.
• Не могут перекрываться с другим #region, но могут находиться внутри условного блока.

Пример

using System;
namespace Directive {
    class RegionDemo {
        public static void Main(string[] args) {
            #region Hello
            Console.WriteLine("Hello");
            Console.WriteLine("Hello");
            Console.WriteLine("Hello");
            Console.WriteLine("Hello");
            Console.WriteLine("Hello");
            #endregion
        }
    }
}

Результат: пять строк "Hello".

Расширенные инструкции компилятора с #pragma

• Позволяет детально управлять поведением компилятора.
• Частое использование:
  • #pragma warning disable — отключает все предупреждения.
  • #pragma warning restore — снова включает предупреждения.
  • Можно таргетировать конкретные номера предупреждений (например, #pragma warning disable CS0168).
  • #pragma checksum — генерирует контрольные суммы для отладки.

Пример

using System;
namespace Directive {
    class PragmaDemo {
        public static void Main(string[] args) {
            #pragma warning disable
            #warning Это предупреждение 1
            #pragma warning restore
            #warning Это предупреждение 2
        }
    }
}

Отображается только второе предупреждение.

Для глубокого понимания обратитесь к официальной документации #pragma.