Тег - описание процедуры, функции, параметров и переменных использующихся в скрипте. Это встроенная в редактор возможность, позволяющая облегчить и ускорить написание скриптов. Информация из тега попадает в сплывающую подсказку автодополнения. Объем информации попадающей в автодополнение зависит от того, в каком месте оно вызывается.
Описание тегов:
· doc - описание переменной, процедуры или функции. Является контейнером для других тегов.
Формат записи:
<doc [ <par ...> ][ <type ...> ][ Комментарий [ %Номер_параметра ] ] [ > ]
Описание тега <doc> заканчивается символом «>» или первой строкой, не являющейся комментарием. Между тегом и определением функции могут располагаться только комментарии, иначе тег будет игнорироваться и не попадет и список автодополнения.
· par - описание параметра процедуры или функции.
Формат записи:
<par [ [ Имя_Параметра | %Номер_параметра] As Тип_Парметра ] [ Коментарий [ %Номер_параметра ] ]>
Комментарий в теге <par> относится только к одному параметру. Если не указать имя или номер параметра, номера присваиваются автоматически по порядку определения параметра в теге.
· type - возвращаемый тип переменной или функции.
Формат записи:
<type [As] Тип>
Если переменная имеет составной тип ( т.е. имеет свойства, например ITCSForm), то при вызове автодополнения будут доступны ее свойства.
В квадратных скобках указаны необязательные параметры.
Текст комментариев может состоять из нескольких строк.
Для вставки имени параметра в комментарий необходимо в комментарии указать порядковый номер параметра после знака «%».
Чтобы вставить в описание символ «<» или «>», необходимо написать требуемый символ два раза: «<<» или «>>».
Общий вид описания процедуры или функции:
'<doc
'<par [[ Параметр1 ] As Тип_Параметра ] [ Комментарий [ %Номер_Параметра ]]>
'<par As Тип_Параметра [ Комментарий [ %Номер_Параметра ]]>
'<par Комментарий [ %Номер_Параметра ] >
'<type [As] Возвращаемый_Тип>
'[ Комментарий к функции [ %Номер_Параметра ] ]
'>
Function Имя_Функции(Параметр1, Параметр2, Параметр3)
...
End Function
Пример:
'<doc
'<par As String Строка символов>
'<par As Integer Длина возвращаемой строки>
'<type String>
'Возвращает строку из %2 символов строки %1 начиная с первого символа
'>
Function GetLeftString(Str, Count)
GetLeftString = Left(Str, Count)
End Function
Отображение всплывающей подсказки при наведении курсора на функцию в окне автодополнения:
Автоматизированное создание тегов
Для автоматизированного создания тегов для готовой функции необходимо установить курсор строкой выше перед описанием функции
ввести '<doc
и нажать клавишу «Enter»
Автоматически в текст программы вставляется фрагмент с описанием типов используемых в функции параметров, отступ для написания комментария и тип возвращаемой переменной. Курсор будет спозиционирован в место написания комментария.
В результате, при вызове автодополнения функции, будет отображаться следующая информация:
См. также: