Комментарии в MQL4: чем они могут быть полезны?

В каждом языке программирования у вас есть возможность добавлять комментарии к нашему коду. Комментарии не являются строго необходимыми для запуска программы, но они очень полезны, если вы имеете дело со сложным кодом. Рассмотрим, как обстоят дела с комментариями в MQL4.

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

Комментарии не будут очень полезны в программе, состоящей всего из нескольких строчек кода. В этом случае вы сможете просто прочитать код и проанализировать, что он делает. Но подумайте о сложном коде программы с несколькими сотнями строк. В данном случае комментарии намного облегчают понимание кода.

Когда лучше использовать комментарии?

  • Для коллаборации с другими разработчиками, если вы вместе работаете над одной программой.
  • В сложных программах комментарии упрощают понимание кода.
  • В длинных программах комментарии помогают структурировать код.
  • Вы можете на время перестать работать над программой и забыть о том, что вы делали. Комментарии помогут освежить вашу память.
  • Когда вы публикуете или делитесь своим исходным кодом, комментарии помогают другим людям разобраться в вашей программе.

Как MetaEditor обрабатывает комментарии? Когда вы компилируете программу, комментарии просто игнорируются компилятором. Они остаются в исходном коде (MQ4), но в исполняемом файле (EX4) они уже отсутствуют.

Существуют два типа комментариев — однострочные и многострочные:

  • Чтобы добавить однострочный комментарий, напишите в своем исходном коде две косые черты — //. Все, что после // будет рассматриваться как комментарий.
  • Чтобы добавить многострочный комментарий, начните комментарий с /* и завершите комментарий */. Все, что находится между /* */, будет обработано как комментарий.

Вот примеры комментариев:

//+------------------------------------------------------------------+
//|                                                        Test1.mq4 |
//|                        Copyright 2019, MetaQuotes Software Corp. |
//|                                             https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2019, MetaQuotes Software Corp."
#property link      "https://www.mql5.com"
#property version   "1.00"
#property strict
//+------------------------------------------------------------------+
//| Script program start function                                    |
//+------------------------------------------------------------------+
void OnStart()
  {
//---
   //Это однострочный комментарий
 
   /*
   Это многострочный комментарий
   И еще комментарий.
   И еще.
   */
 
   //Данная функция выводит сообщение в отдельном окне.
   Alert("Привет, мир!");  //Здесь мы также можем написать комментарий.
 
  }
//+------------------------------------------------------------------+

Как видно из примера, в скрипте много однострочных комментариев и один многострочный комментарий. Давайте посмотрим, как бы выглядел исходный код без каких-либо комментариев:

#property copyright "Copyright 2019, MetaQuotes Software Corp."
#property link      "https://www.mql5.com"
#property version   "1.00"
#property strict
void OnStart()
  {
   Alert("Привет, мир!");
  }

Конечно, программа выглядит короче, чем с комментариями и данные части кода абсолютно идентичны и выполняют одну и ту же задачу. Комментарии в MQL4 делают ваш код длиннее, однако они помогают вам.