Комментирование процедур и функций

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

Часто бывает так, что комментарии длинные и не помещаются на одной строке. Чтобы быстро продолжить комментарий на следующей строке, вы можете нажать Shift+Ввод.

Автоматически будет добавлена новая строка, которая уже содержит символ комментария в начале.

При редактировании текста часто используется контекстная подсказка. Она может работать не только для типов, определенных в платформе, но и для ваших собственных процедур и функций. Для этого нужно, чтобы комментарии к ним были составлены по определенным правилам.

Проще всего добавить такой комментарий с помощью самой контекстной подсказки.

  1. Установите курсор в пустую строку, непосредственно перед объявлением процедуры или функции.
  2. Нажмите Ctrl+Пробел, чтобы вызвать контекстную подсказку.
  3. Нажмите /, чтобы в контекстной подсказке появилась подсказка // ... Процедура.
  4. Нажмите Ввод.

В тексте появится "правильный" комментарий, а фрагменты, в которые вам нужно ввести собственный текст, будут отмечены маркерами. Вы можете перемещаться между маркерами, нажимая Tab.

Аналогичные действия вы можете выполнить, нажав Источник > Генерировать комментарии метода в контекстном меню редактора встроенного языка.