101
Во-первых, комментарии позволяют отделить одну логически обособленную часть
программы от другой. Гораздо легче читать удобно форматированный текст, нежели
текст, составленный сплошным потоком.
Во-вторых, построчные комментарии позволяют пояснить обычными словами, что имел
ввиду программист в каждой отдельно взятой строке кода.
В-третьих, в верхней части программы можно указать некоторый набор сведений,
касающихся программы в целом: фамилию и реквизиты автора (в том числе, авторский
сайт, адрес электронной почты и пр.), назначение программы (является она законченной
торгующей программой или библиотечной функцией), основные её характеристики и
ограничения, а также другую полезную информацию на усмотрение автора.
Каждый программист по своему вкусу может выбрать любой удобный ему стиль
комментариев. Стиль, предлагаемый разработчиками языка MQL4, представлен в эксперте
create.mq4. Рассмотрим основные особенности любого приемлемого стиля оформления
программы.
1. Длина строки кода не должна превышать размер основного окна. Это ограничение не
является формальным требованием синтаксиса языка, однако чтение программы,
содержащей длинные строки, очень неудобно. Любую длинную строку всегда можно
расположить в несколько программных строк, так, чтобы все они были полностью видны
на экране. Для монитора с разрешением 1024 х 768 пикселей максимальная длина строки
составляет 118 символов.
2. Объявление переменных осуществляется в начале программы. К каждой переменной
желательно дать описание в комментарии: кратко отметить сущность и (если необходимо)
особенности использования переменной.
3. Каждый оператор желательно располагать в отдельной строке.
4. Построчный комментарий, если он присутствует в строке, должен начинаться с 76
позиции (рекомендуется для мониторов 17" с разрешением 1024 х 768 пикс.). Это
требование также не является обязательным. Например, если строка кода занимает 80
позиций, то её не обязательно разбивать на две строки, можно написать комментарий,
начиная с 81 позиции. Обычно содержательная часть программы (код) составляют строки
длиной около 50 символов, поэтому построчный комментарий выглядит как столбец
текста в правой части экрана.