Комментарии в коде и работа с ними

В языке программирования SimInTech есть несколько способов для создания комментариев в тексте программы. При создании комментариев применяются символы // (две косые черты) и {} (фигурные скобки).

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

Однострочные комментарии

Однострочные комментарии начинаются с символов //: весь текст, который написан после данных символов, будет являться комментарием.

Действие однострочного комментария продолжается до конца строки, в которой он был применён, и на следующую строку не распространяется.

Однострочный комментарий может находиться как на отдельной строке:

//Отдельная строка с однострочным комментарием

Так и дополнять строку с программным кодом:

var i: integer, //Использование этой переменной оправдано в самых крайних случаях
    b: boolean; //А эту можно использовать всегда

Многострочные комментарии

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

Многострочный комментарий выглядит следующим образом:

var i: integer,
    b: boolean;

{
Это многострочный комментарий
в языке программирования SimInTech
}

Комментарий с использованием фигурных скобок допустимо использовать для дополнения строки с программным кодом:

var i: integer, {Вот так создавать комментарии тоже можно}
    b: boolean;

Прим.:

В SimInTech применение фигурных скобок имеет двойное назначение: фигурные скобки используются как при комментировании, так и при обработке секции текстового процессора formattext. Поэтому применение фигурных скобок не всегда будет означать комментарий в тексте и необходимо обращать внимание на контекст использования фигурных скобок.

formattext
  {Аннушка уже разлила масло}  //Текст в фигурных скобках - комментарий
  sig_value = {Name}_value;      //Текст в фигурных скобках - НЕ комментарий
end;

Быстрое комментирование с помощью горячих клавиш

Редактор языка программирования SimInTech поддерживает быстрое создание комментариев в тексте программы. Действие по быстрому созданию комментариев может быть применено как к строке, на которой находится курсор в текущий момент времени, так и к выделенному фрагменту, в составе которого находится несколько строк.

Для быстрого создания/удаления комментария могут быть использованы два сочетания клавиш:

Ctrl + [?, /] (код клавиши: 191) - при применении комбинации строка, на которой находится курсор, или все строки в выделенном фрагменте получат в начале символы //.
Например, исходный выделенный фрагмент до комментирования:
```
k = 10#0;

for (i= 1, 10) begin
  k[i] = pi*i;
end;
```
Исходный выделенный фрагмент после комментирования:
```
//k = 10#0;
//
//for (i= 1, 10) begin
//  k[i] = pi*i;
//end;
```
Удалить комментирование строки или выделенного фрагмента можно этой же комбинацией (при этом удалить комментирование можно только с одной или нескольких строк, не трогая весь фрагмент целиком).
Нужно помнить, что если в выделенном фрагменте будут строки, уже содержащие символы // в начале строки, то при применении комбинации, они будут раскомментированы, что может привести к различным ошибкам при исполнении программного кода.
Например, исходный выделенный фрагмент до комментирования (одна из строк изначально закомментирована):
```
k = 10#0;

for (i= 1, 10) begin
//  k[i] = pi*i;
end;
```
Исходный выделенный фрагмент после комментирования:
```
//k = 10#0;
//
//for (i= 1, 10) begin
  k[i] = pi*i;
//end;
```
Видно, что в результате комментирования та строка, которая изначально была закомментирована, перестала быть таковой, и это может привести к нежелательным последствиям при исполнении программного кода.
Ctrl + Shift + [?, /] (код клавиши: 191) - при применении комбинации строка, на которой находится курсор, или все строки в выделенном фрагменте будут обрамлены символами {}.
Например, исходный выделенный фрагмент до комментирования:
```
for I = 1, 10 begin
  k = k + 1;
end;
```
Исходный выделенный фрагмент после комментирования:
```
{for I = 1, 10 begin
  k = k + 1;
end;}
```
Удалить комментирование строки или выделенного фрагмента можно этой же комбинацией (при удалении комментирования с фрагмента необходимо, чтобы был выделен весь фрагмент, находящийся под комментированием).

Совместное использование комментариев, созданных разным способом

В языке программирования SimInTech допускается совместное использование разных способов комментирования:

{

//Этот комментарий был сделан другим способом.
//И будет оставаться комментарием, даже если будут убраны фигурные скобки

for (i= 1, 10) begin
  k[i] = pi*i;
end;}

Фрагмент программного кода, приведенный выше, содержит оба вида комментариев, поэтому в случае удаления символов {}, текст который находится за символами // останется закомментированным.