Директиви попереднього процесора C #

У цьому підручнику ми дізнаємося про директиви про препроцесор, доступні директиви в C #, а також коли, чому та як вони використовуються.

Як виправдовує назва, директиви препроцесора - це блок операторів, який обробляється до початку фактичної компіляції. Директиви препроцесора C # - це команди для компілятора, які впливають на процес компіляції.

Ці команди визначають, які розділи коду компілювати або як обробляти конкретні помилки та попередження.

Директива препроцесора C # починається із # (hash)символу, а всі директиви препроцесора тривають один рядок. Препроцесорні директиви припиняються new lineзамість semicolon.

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

Директиви попереднього процесора в C #
Директива про препроцесор Опис Синтаксис
#if Перевіряє, чи є вираз препроцесора істинним чи ні 
 #if код препроцесора-виразу для компіляції #endif
#elif Використовується разом з #ifдля перевірки декількох виразів препроцесора 
 #if код препроцесора-виразу-1 для компіляції #elif код препроцесора-виразу-2 для компіляції #endif
#else Використовується разом з #ifдля створення складеної умовної директиви. 
 #if код препроцесора-виразу для компіляції #elif код для компіляції #endif
#endif Використовується разом із #ifдля позначення кінця умовної директиви 
 #if код препроцесора-виразу для компіляції #endif
#define Використовується для визначення символу 
 #define SYMBOL
#undef Використовується для невизначення символу 
 #undef СИМВОЛ
#warning Дозволяє нам генерувати попередження рівня 1 з нашого коду 
 # попередження-попередження
#error Дозволяє нам генерувати помилки з нашого коду 
 # повідомлення про помилку
#line Дозволяє нам змінити номер рядка та ім'я компілятора для відображення помилок та попереджень 
 # рядок-номер рядка-ім'я файлу
#region Дозволяє нам створити область, яку можна розгорнути або згорнути під час використання редактора коду Visual Studio 
 # регіон регіон-опис коди # ендрегіон
#endregion Позначає кінець регіону 
 # регіон регіон-опис коди # ендрегіон
#pragma Дає компілятору спеціальні вказівки щодо компіляції файлу, в якому він відображається. 
 #pragma pragma-name прагма-аргументи

#define директива

  • #defineДиректива дозволяє визначити символ.
  • Символи, які визначаються при використанні разом із #ifдирективою, вважатимуться істинними.
  • Ці символи можуть бути використані для визначення умов компіляції.
  • Синтаксис: 
     #define SYMBOL
  • Наприклад: 
     #define TESTING
    Тут ТЕСТУВАННЯ - це символ.

директива #undef

  • #undefДиректива дозволяє невизначеним символ.
  • Невизначені символи при використанні разом із #ifдирективою оцінюватимуться як помилкові.
  • Синтаксис: 
     #undef СИМВОЛ
  • Наприклад: 
     #undef ТЕСТУВАННЯ
    Тут ТЕСТУВАННЯ - це символ.

#if директива

  • #ifДиректива використовується для перевірки вираження препроцесора.
  • Вираз препроцесора може складатися лише із символу або комбінації символів разом з операторами, такими як &&(І), ||(АБО), !(НЕ).
  • #ifза директивою слідує #endifдиректива.
  • Коди всередині #ifдирективи компілюються лише в тому випадку, якщо вираз, перевірений за допомогою, #ifмає значення true.
  • Синтаксис: 
     #if код препроцесора-виразу для компіляції <#endif
  • Наприклад: 
    #if TESTING Console.WriteLine ("В даний час тестується"); #endif

Приклад 1: Як використовувати директиву #if?

 #define CSHARP using System; namespace Directive ( class ConditionalDirective ( public static void Main(string() args) ( #if (CSHARP) Console.WriteLine("CSHARP is defined"); #endif ) ) )

Коли ми запускаємо програму, результат буде:

 CSHARP is defined

In the above program, CSHARP symbol is defined using the #define directive at the beginning of program. Inside the Main() method, #if directive is used to test whether CSHARP is true or not. The block of code inside #if directive is compiled only if CSHARP is defined.

#elif directive

  • The #elif directive is used along with #if directive that lets us create a compound conditional directive.
  • It is used when testing multiple preprocessor expression.
  • The codes inside the #elif directive is compiled only if the expression tested with that #elif evaluates to true.
  • Syntax: 
     #if preprocessor-expression-1 code to compile #elif preprocessor-expression-2 code-to-compile #endif
  • For example: 
     #if TESTING Console.WriteLine("Currently Testing"); #elif TRAINING Console.WriteLine("Currently Training"); #endif

#else directive

  • The #else directive is used along with #if directive.
  • If none of the expression in the preceding #if and #elif (if present) directives are true, the codes inside the #else directive will be compiled.
  • Syntax: 
     #if preprocessor-expression-1 code to compile #elif preprocessor-expression-2 code-to-compile #else code-to-compile #endif
  • For example: 
     #if TESTING Console.WriteLine("Currently Testing"); #elif TRAINING Console.WriteLine("Currently Training"); #else Console.WriteLine("Neither Testing nor Training"); #endif

#endif directive

  • The #endif directive is used along with #if directive to indicate the end of #if directive.
  • Syntax: 
     #if preprocessor-expression-1 code to compile #endif
  • For example: 
     #if TESTING Console.WriteLine("Currently Testing"); #endif

Example 2: How to use conditional directive (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 and PYTHON are defined"); #elif (CSHARP && !PYTHON) Console.WriteLine("CSHARP is defined, PYTHON is undefined"); #elif (!CSHARP && PYTHON) Console.WriteLine("PYTHON is defined, CSHARP is undefined"); #else Console.WriteLine("CSHARP and PYTHON are undefined"); #endif ) ) )

When we run the program, the output will be:

 CSHARP is defined, PYTHON is undefined

In this example, we can see the use of #elif and #else directive. These directive are used when there are multiple conditions to be tested. Also, symbols can be combined using logical operators to form a preprocessor expression.

#warning directive

  • The #warning directive allows us to generate a user-defined level one warning from our code.
  • Syntax: 
     #warning warning-message
  • For example: 
     #warning This is a warning message

Example 3: How to use #warning directive?

 using System; namespace Directives ( class WarningDirective ( public static void Main(string() args) ( #if (!CSHARP) #warning CSHARP is undefined #endif Console.WriteLine("#warning directive example"); ) ) )

When we run the program, the output will be:

 Program.cs(10,26): warning CS1030: #warning: 'CSHARP is undefined' (/home/myuser/csharp/directives-project/directives-project.csproj) #warning directive example

After running the above program, we will see the output as above. The text represents a warning message. Here, we are generating a user-defined warning message using the #warning directive.

Note that the statements after the #warning directive are also executed. It means that the #warning directive does not terminate the program but just throws a warning.

#error directive

  • The #error directive allows us to generate a user-defined error from our code.
  • Syntax: 
     #error error-message
  • For example: 
     #error This is an error message

Example 4: How to use #error directive?

 using System; namespace Directive ( class Error ( public static void Main(string() args) ( #if (!CSHARP) #error CSHARP is undefined #endif Console.WriteLine("#error directive example"); ) ) )

When we run the program, the output will be:

 Program.cs(10,24): error CS1029: #error: 'CSHARP is undefined' (/home/myuser/csharp/directives-project/directives-project.csproj) The build failed. Please fix the build errors and run again.

We will see some errors, probably like above. Here we are generating a user-defined error.

Another thing to note here is the program will be terminated and the line #error directive example won't be printed as it was in the #warning directive.

#line directive

  • The #line directive allows us to modify the line number and the filename for errors and warnings.
  • Syntax: 
     #line line-number file-name
  • For example: 
     #line 50 "fakeprogram.cs"

Example 5: How to use #line directive?

 using System; namespace Directive ( class Error ( public static void Main(string() args) ( #line 200 "AnotherProgram.cs" #warning Actual Warning generated by Program.cs on line 10 ) ) )

When we run the program, the output will be:

 AnotherProgram.cs(200,22): warning CS1030: #warning: 'Actual Warning generated by Program.cs on line 10' (/home/myuser/csh arp/directive-project/directive-project.csproj)

We have saved the above example as Program.cs. The warning was actually generated at line 10 by Program.cs. Using the #line directive, we have changed the line number to 200 and the filename to AnotherProgram.cs that generated the error.

#region and #endregion directive

  • The #region directive allows us to create a region that can be expanded or collapsed when using a Visual Studio Code Editor.
  • This directive is simply used to organize the code.
  • The #region block can not overlap with a #if block. However, a #region block can be included within a #if block and a #if block can overlap with a #region block.
  • #endregion directive indicates the end of a #region block.
  • Syntax: 
     #region region-description codes #endregion

Example 6: How to use #region directive?

 using System; namespace Directive ( class Region ( public static void Main(string() args) ( #region Hello Console.WriteLine("Hello"); Console.WriteLine("Hello"); Console.WriteLine("Hello"); Console.WriteLine("Hello"); Console.WriteLine("Hello"); #endregion ) ) )

When we run the program, the output will be:

 Hello Hello Hello Hello Hello

#pragma directive

  • The #pragma directive is used to give the compiler some special instructions for the compilation of the file in which it appears.
  • The instruction may include disabling or enabling some warnings.
  • C# supports two #pragma instructions:
    • #pragma warning: Used for disabling or enabling warnings
    • #pragma checksum: It generates checksums for source files which will be used for debugging.
  • Syntax: 
     #pragma pragma-name прагма-аргументи
  • Наприклад: 
     #pragma попередження вимкнено

Приклад 7: Як використовувати директиву #pragma?

 using System; namespace Directive ( class Error ( public static void Main(string() args) ( #pragma warning disable #warning This is a warning 1 #pragma warning restore #warning This is a warning 2 ) ) )

Коли ми запускаємо програму, результат буде:

 Program.cs (12,22): попередження CS1030: # Warning: 'Це попередження 2' (/home/myuser/csharp/directive-project/directive-project.csproj)

Ми бачимо, що на екрані виводу відображається лише друге попередження .

Це тому, що спочатку ми відключили всі попередження до першого попередження та відновили їх лише до другого попередження. Це причина, чому перше попередження було приховано.

Ми також можемо вимкнути конкретне попередження замість усіх попереджень.

Щоб дізнатись більше про це #pragma, відвідайте #pragma (посилання на C #).

Цікаві статті...